Skip to content

Commit

Permalink
Switch to MkDocs for Pydoc-Markdown docs (#210)
Browse files Browse the repository at this point in the history
* move package files into project root

* update GH action

* update .readthedocs-custom-steps

* update GH action and RTD reqs

* use "$PYTHON" variable in custom steps

* update

* bump dep

* fix search path and add Jinja2 renderer docs

* move stuff

* m

* write into _build/html

* dbg

* update

* fix

* update RTD template

* update copyright year

* update README

* add repo url to config

* fix: fix `mkdocs` bootstrap configuration, update mkdocs and hugo bootstrap config to include example on how to select parts of the API docs
  • Loading branch information
NiklasRosenstein authored Aug 20, 2021
1 parent 3338f0a commit c2bf669
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
5 changes: 5 additions & 0 deletions .changelog/_unreleased.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,8 @@ changes:
component: general
description: update template for `--bootstrap readthedocs` and related documentation
fixes: []
- type: fix
component: general
description: fix `mkdocs` bootstrap configuration, update mkdocs and hugo bootstrap
config to include example on how to select parts of the API docs
fixes: []
16 changes: 9 additions & 7 deletions src/pydoc_markdown/static.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,13 @@
name: index
source: README.md
- title: API Documentation
contents:
- '*'
children:
- title: my_project
content: [ my_project, my_project.* ]
mkdocs_config:
mkdocs_config:
site_name: My Project
theme: readthedocs
site_name: My Project
theme: readthedocs
repo_url: https://github.com/Me/my-project
'''.lstrip()


Expand All @@ -78,8 +79,9 @@
name: index
source: README.md
- title: API Documentation
contents:
- '*'
children:
- title: my_project
content: [ my_project, my_project.* ]
'''.lstrip()

DEFAULT_DOCUSAURUS_CONFIG = '''
Expand Down

0 comments on commit c2bf669

Please sign in to comment.