Skip to content
Merged
Show file tree
Hide file tree
Changes from 54 commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
ba372db
mypy and adjust to docspec-2.0.0 alpha
NiklasRosenstein Feb 23, 2022
bacaf96
mypy with untyped defs
NiklasRosenstein Feb 23, 2022
0d21269
add more type hints
NiklasRosenstein Feb 23, 2022
6e8ad31
Merge branch 'develop' into adopt-new-docspec
NiklasRosenstein Feb 23, 2022
507e340
update project and ci
NiklasRosenstein Feb 23, 2022
2021cae
update workflow
NiklasRosenstein Feb 23, 2022
27996bf
update workflow
NiklasRosenstein Feb 23, 2022
d8a2cd8
fix project config
NiklasRosenstein Feb 23, 2022
e72d2d7
bump dependency on 2.0.0a1
NiklasRosenstein Feb 23, 2022
e78b81d
update type hint
NiklasRosenstein Feb 24, 2022
32e5cb7
depend on tomli and tomli_w
NiklasRosenstein Feb 24, 2022
6dd2410
fix hwo the markdown renderer identifies the header level (broke due …
NiklasRosenstein Feb 24, 2022
634ac56
hygiene: remove `MarkdownRenderer.classdef_render_init_signature_if_n…
NiklasRosenstein Feb 24, 2022
a6b0283
breaking change: remove `MarkdownRenderer.render_to_stream()` from pu…
NiklasRosenstein Feb 24, 2022
891d106
add missing types-* dependencies
NiklasRosenstein Feb 24, 2022
943a32b
add jinja dep
NiklasRosenstein Feb 24, 2022
7a8d639
clean some deps
NiklasRosenstein Feb 24, 2022
d81646d
use is_relative_to from nr.util.fs for 3.8 and 3.7 compatibility
NiklasRosenstein Feb 24, 2022
3545c1f
bump
NiklasRosenstein Feb 24, 2022
f9e4572
start updating docs to build them with Novella
NiklasRosenstein Feb 24, 2022
4b0f964
remove .readthedocs.yml
NiklasRosenstein Feb 24, 2022
7d8ca83
add to docs/requirements.txt
NiklasRosenstein Feb 24, 2022
927af94
update docs
NiklasRosenstein Feb 24, 2022
2782ceb
need novella==0.1.5 at least
NiklasRosenstein Feb 24, 2022
61305aa
convert changelogs
NiklasRosenstein Feb 24, 2022
dc6554b
add PR links
NiklasRosenstein Feb 24, 2022
2c4cbca
install pydoc-markdown in docs build
NiklasRosenstein Feb 24, 2022
80631f6
first implementation of `@pydoc` tag
NiklasRosenstein Feb 24, 2022
ebc1431
move novella dep to "novella" extra, add "docs" extra
NiklasRosenstein Feb 24, 2022
bad5b3f
update ci
NiklasRosenstein Feb 24, 2022
588ac13
enable pushing to gh pages
NiklasRosenstein Feb 24, 2022
2175538
fix syntax in pyproject.toml
NiklasRosenstein Feb 24, 2022
f8fe70d
fix mypy
NiklasRosenstein Feb 24, 2022
46bea0f
need to exclude pydoc_markdown.novella for now because we cant verify…
NiklasRosenstein Feb 24, 2022
be7b432
add using-novella.md
NiklasRosenstein Feb 24, 2022
88a733d
spell
NiklasRosenstein Feb 24, 2022
6fb50de
automatically detect source linker config for github.com, gitlab.com …
NiklasRosenstein Feb 24, 2022
34fb530
remove unused import
NiklasRosenstein Feb 24, 2022
224b5cf
feature: add `pydoc_markdown.interfaces.SingleObjectRenderer` and use…
NiklasRosenstein Feb 24, 2022
36fbc1c
features
NiklasRosenstein Feb 24, 2022
b9ce3e1
mypy
NiklasRosenstein Feb 24, 2022
c3090d0
Merge remote-tracking branch 'origin/develop' into adopt-new-docspec
NiklasRosenstein Feb 24, 2022
38ea262
move accidentally ill-located changelogs for 4.4.0 to correct file
NiklasRosenstein Feb 24, 2022
6720f80
implement `@pylink` tag
NiklasRosenstein Feb 27, 2022
ece4728
feature: bring back formatting function, class and variable signature…
NiklasRosenstein Feb 27, 2022
ffe2d9d
add yapf dependency
NiklasRosenstein Feb 27, 2022
ef78ed8
ignore types for yapf
NiklasRosenstein Feb 27, 2022
ae9ac51
fix: fix forwarding of `PluginBase.init()` calls to sub-plugins in un…
NiklasRosenstein Feb 27, 2022
7905c94
update function signature style (no trailing colon)
NiklasRosenstein Feb 27, 2022
ced81a1
update docs
NiklasRosenstein Feb 27, 2022
1cfe3d8
git fetch before building docs
NiklasRosenstein Feb 27, 2022
2093d5d
update pr numbers from ci
NiklasRosenstein Feb 27, 2022
e3c09ee
fix update-pr-numbers
NiklasRosenstein Feb 27, 2022
ebef0bb
Update changelog PR references
Feb 27, 2022
15fa3a7
Update .changelog/_unreleased.toml
NiklasRosenstein Feb 27, 2022
794105e
update git describe in index.md
NiklasRosenstein Feb 27, 2022
a55beff
remove pydoc-markdown.yml, disable render_module_header by default fo…
NiklasRosenstein Feb 27, 2022
d8ca336
use fetch-depth: 0 to make git describe --tag work
NiklasRosenstein Feb 28, 2022
dbcd107
use GITHUB_HEAD_REF is available
NiklasRosenstein Feb 28, 2022
64ea3c4
fix links to source code (hopefully)
NiklasRosenstein Feb 28, 2022
aef10f9
fix ci
NiklasRosenstein Feb 28, 2022
015be97
improvement: do not render link to source for modules in `MarkdownRen…
NiklasRosenstein Feb 28, 2022
44674cb
Update changelog PR references
Feb 28, 2022
8b8dfd6
cache loaded modules in Pydoc preprocessor, use new `MarkdownPreproce…
NiklasRosenstein Feb 28, 2022
8fb40ee
bump novella dep
NiklasRosenstein Feb 28, 2022
6b1ce57
<3.10 syntax
NiklasRosenstein Feb 28, 2022
ea58b55
Merge branch 'develop' into adopt-new-docspec
NiklasRosenstein Feb 28, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changelog/3.0.0.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
release-date = "2020-05-12"

[[entries]]
id = "e16ef453-65f1-4a46-8d00-540040a64726"
type = "feature"
description = "Initial release of Pydoc-Markdown v3."
author = "@NiklasRosenstein"
6 changes: 0 additions & 6 deletions .changelog/3.0.0.yml

This file was deleted.

49 changes: 49 additions & 0 deletions .changelog/3.0.1.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
release-date = "2020-05-16"

[[entries]]
id = "b58a872f-3020-4fa3-9779-7813fd287fcd"
type = "feature"
description = "cli: added `--version` option"
author = "@NiklasRosenstein"

[[entries]]
id = "f09ef20d-4bd1-4ee5-a59a-d3fb54b42225"
type = "feature"
description = "cli: added `-p,--package` option (which overrides `PythonLoader.packages`)"
author = "@NiklasRosenstein"

[[entries]]
id = "c67d5185-17b3-4fb2-9853-150f824380fd"
type = "feature"
description = "utils: added `pydoc_markdown.utils.page` module"
author = "@NiklasRosenstein"

[[entries]]
id = "f225eea2-6912-4ed3-8b46-0387cdb1e09e"
type = "feature"
description = "cli: added `RenderSession` class to `pydoc_markdown.main` module which makes the cli logic easier to maintain and re-use."
author = "@NiklasRosenstein"

[[entries]]
id = "94539d09-f829-4759-b454-5d63c04f164d"
type = "feature"
description = "markdown: added hidden `MarkdownRenderer.fp` option"
author = "@NiklasRosenstein"

[[entries]]
id = "22cac368-b61e-4aa6-bfcb-b0aaa9eb6384"
type = "feature"
description = "python: added `PythonLoader.packages` option"
author = "@NiklasRosenstein"

[[entries]]
id = "48e5c895-51dc-430f-a482-405d5c637965"
type = "improvement"
description = "python: changed behavior of `PythonLoader.modules` option (it will not only load the module that was explicitly specified and exclude any sub-modules, if applicable)."
author = "@NiklasRosenstein"

[[entries]]
id = "0917ae7d-9e5c-4c4f-bb4c-68c55c98d7b8"
type = "improvement"
description = "cli: dynamically lookup `MarkdownRenderer` configuration from the renderer to support renderers other than `MarkdownRenderer` and `MkdocsRenderer` that supply a `markdown` field that is an instance of `MarkdownRenderer` (so they can be used with `--render-toc` as well)."
author = "@NiklasRosenstein"
40 changes: 0 additions & 40 deletions .changelog/3.0.1.yml

This file was deleted.

7 changes: 7 additions & 0 deletions .changelog/3.0.2.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
release-date = "2020-05-16"

[[entries]]
id = "c1dd833e-d301-44e4-a84b-06b679b2e878"
type = "fix"
description = "mkdocs: fix `NameError` in `MkdocsRenderer`"
author = "@NiklasRosenstein"
6 changes: 0 additions & 6 deletions .changelog/3.0.2.yml

This file was deleted.

55 changes: 55 additions & 0 deletions .changelog/3.1.0.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
release-date = "2020-06-04"

[[entries]]
id = "18f18e63-e1c2-4da6-813e-b77983ba3a30"
type = "improvement"
description = "cli: rename `--watch-and-serve` option to `--server`"
author = "@NiklasRosenstein"

[[entries]]
id = "4035ad6e-f9c9-4436-93c7-9836160ca5a0"
type = "improvement"
description = "cli: watch and serve mainloop now reloads the config file and does not open the browser another time if it was already opened once."
author = "@NiklasRosenstein"

[[entries]]
id = "4f7d791d-33a4-481a-8481-4f9ee8a29763"
type = "fix"
description = "cli: fix `pydoc-markdown.yml` generated with `--bootstrap`"
author = "@NiklasRosenstein"
issues = [
"https://github.com/NiklasRosenstein/pydoc-markdown/issues/118",
]

[[entries]]
id = "c2e12520-2262-4ebc-8c2f-c3931dd3fb44"
type = "improvement"
description = "markdown: * change default for `header_level_by_type` (`2` to `1` for modules, `3` to `2` for classes).\n* change default for `descriptive_class_title` (`false` to `true`)\n"
author = "@NiklasRosenstein"

[[entries]]
id = "d15033e5-d2c5-4632-9fda-cbc1288a5b18"
type = "feature"
description = "markdown: added `content_directory` option (replaces hardcoded default `docs` value, defaults to `content` now)"
author = "@NiklasRosenstein"

[[entries]]
id = "b222638d-ea90-489d-911e-3192454ac900"
type = "improvement"
description = "markdown: renamed `clean_docs_directory_on_render` to `clean_render` and change the default from `true` to `false`."
author = "@NiklasRosenstein"

[[entries]]
id = "a0286043-a024-40c6-8e31-f20c5de4d243"
type = "improvement"
description = "mkdocs: `mkdocs_config` option can now be set to `null` (the renderer will the refrain\nfrom writing a `mkdocs.yml` file into the output directory).\n"
author = "@NiklasRosenstein"

[[entries]]
id = "10d731a8-3f0a-416d-a679-6b7f82b2e0b9"
type = "fix"
description = "python: fix assignments with annotations being ignored by the parser"
author = "@NiklasRosenstein"
issues = [
"https://github.com/NiklasRosenstein/pydoc-markdown/issues/115",
]
49 changes: 0 additions & 49 deletions .changelog/3.1.0.yml

This file was deleted.

10 changes: 10 additions & 0 deletions .changelog/3.1.1.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
release-date = "2020-06-26"

[[entries]]
id = "720ef091-a57c-4a20-80a3-cac24e1ba04a"
type = "improvement"
description = "dependencies: bump dependency on `nr.databind.core` to `~0.0.18` to avoid picking up the bad `0.0.17` version"
author = "@NiklasRosenstein"
issues = [
"https://github.com/NiklasRosenstein/pydoc-markdown/issues/126",
]
8 changes: 0 additions & 8 deletions .changelog/3.1.1.yml

This file was deleted.

7 changes: 7 additions & 0 deletions .changelog/3.10.0.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
release-date = "2021-02-20"

[[entries]]
id = "f6351a2b-09b6-483e-9272-783816239f97"
type = "feature"
description = "add `PythonLoader.encoding` option"
author = "@NiklasRosenstein"
6 changes: 0 additions & 6 deletions .changelog/3.10.0.yml

This file was deleted.

10 changes: 10 additions & 0 deletions .changelog/3.10.1.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
release-date = "2021-04-02"

[[entries]]
id = "c18ca885-4bd4-47b6-99df-e020841dd693"
type = "fix"
description = "fix code blocks indentation in `SphinxProcessor`"
author = "@NiklasRosenstein"
issues = [
"https://github.com/NiklasRosenstein/pydoc-markdown/issues/179",
]
7 changes: 0 additions & 7 deletions .changelog/3.10.1.yml

This file was deleted.

19 changes: 19 additions & 0 deletions .changelog/3.10.3.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
release-date = "2021-05-09"

[[entries]]
id = "eeee53d5-8969-470b-9e75-9bc9b33632f3"
type = "fix"
description = "sort sidebar items in docusaurus"
author = "@NiklasRosenstein"
issues = [
"https://github.com/NiklasRosenstein/pydoc-markdown/issues/183",
]

[[entries]]
id = "64c4e16c-e2d0-4443-9298-87625e9a0959"
type = "fix"
description = "replace backslashes with forward slashes in docusaurus sidebar (actually in 3.10.2)"
author = "@NiklasRosenstein"
issues = [
"https://github.com/NiklasRosenstein/pydoc-markdown/issues/129",
]
13 changes: 0 additions & 13 deletions .changelog/3.10.3.yml

This file was deleted.

13 changes: 13 additions & 0 deletions .changelog/3.11.0.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
release-date = "2021-05-20"

[[entries]]
id = "6db4acf2-6c84-46b9-9a04-1ea95f063254"
type = "feature"
description = "Add support for getting configuration from pyproject.toml under the [tool.pydoc-markdown] table"
author = "@NiklasRosenstein"

[[entries]]
id = "ec6c7aa9-dd90-49e5-92cc-9e7d9ffbaa32"
type = "fix"
description = "fix docstring in PydocmdPreprocessor"
author = "@NiklasRosenstein"
11 changes: 0 additions & 11 deletions .changelog/3.11.0.yml

This file was deleted.

10 changes: 10 additions & 0 deletions .changelog/3.12.0.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
release-date = "2021-05-21"

[[entries]]
id = "1e05ec39-a169-4e01-99a9-8c7059e96840"
type = "feature"
description = "SphinxProcessor: parse `type` and `rtype`"
author = "@NiklasRosenstein"
issues = [
"https://github.com/NiklasRosenstein/pydoc-markdown/issues/157",
]
6 changes: 0 additions & 6 deletions .changelog/3.12.0.yml

This file was deleted.

13 changes: 13 additions & 0 deletions .changelog/3.12.1.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
release-date = "2021-05-21"

[[entries]]
id = "98dfb860-1be0-4594-9098-a0a8bb9c0529"
type = "fix"
description = "add missing `dataclasses` dependency for Python 3.6 compatibility"
author = "@NiklasRosenstein"

[[entries]]
id = "af994467-d624-4074-a960-75baf503e10f"
type = "fix"
description = "set minimum Python version in `package.yml` to `^3.6`"
author = "@NiklasRosenstein"
10 changes: 0 additions & 10 deletions .changelog/3.12.1.yml

This file was deleted.

7 changes: 7 additions & 0 deletions .changelog/3.13.0.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
release-date = "2021-05-29"

[[entries]]
id = "133eabd9-0af2-426d-8b71-aab963db0901"
type = "improvement"
description = "upgrade to `docspec-python~0.2.0`"
author = "@NiklasRosenstein"
6 changes: 0 additions & 6 deletions .changelog/3.13.0.yml

This file was deleted.

Loading