Skip to content

#33 rtd documentation #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 22 commits into from
Oct 8, 2021
Merged

#33 rtd documentation #59

Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
558f58c
Adds RTD files and dependencies
josh-silvas Jun 21, 2021
1927dd8
Adds RTD requirements
josh-silvas Jun 21, 2021
f5f9357
Adds sphinx callback for RTD to run apidoc generator.
josh-silvas Jun 21, 2021
02e60f4
Update getting_started/index.rst line lengh
josh-silvas Jun 21, 2021
888c12e
Updates docs/conf.py with correct root directory.
josh-silvas Jun 21, 2021
3ec327e
Adds import of diffsync library
josh-silvas Jun 21, 2021
66919a9
Updates path imports
josh-silvas Jun 21, 2021
8bf41b3
Updates doc requirements.txt
josh-silvas Jun 21, 2021
77eb691
Add invoke commands for documentation.
josh-silvas Jun 22, 2021
ef16cae
Adds small changes for tests.
josh-silvas Jun 22, 2021
dc9f57b
Move doc requirements into pyproject.toml
josh-silvas Jun 22, 2021
2691199
Adds toml to optional poetry install
josh-silvas Jun 22, 2021
1b7e07e
Updates toml version
josh-silvas Jun 22, 2021
665dd0d
Update example titles.
josh-silvas Jun 22, 2021
4edb610
Update documentation and homepage reference in pyproject.toml to poin…
josh-silvas Jun 22, 2021
63865d0
Update docs/source/conf.py
josh-silvas Jun 22, 2021
65e19ca
Convert from sphinx to mkdocs as per the standard.
josh-silvas Jun 23, 2021
3960411
Updates poetry.extras for the docs
josh-silvas Jun 23, 2021
09fac74
Adds doc dependencies in as optional
josh-silvas Jun 23, 2021
9885456
Revert to sphinx
josh-silvas Jun 23, 2021
811af15
Fixes separate pages for api reference.
josh-silvas Jun 23, 2021
ca2a51e
Removes api_doc invoke function as this is now handled via a sphinx c…
josh-silvas Jun 23, 2021
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
Prev Previous commit
Next Next commit
Updates poetry.extras for the docs
  • Loading branch information
@josh-silvas
josh-silvas committed Jun 23, 2021
commit 3960411eacf845783d0912f67320871328ae0a09
5 changes: 5 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ mkdocs = "^1.2.1"
mkdocstrings = "^0.15.2"
mkdocs-include-markdown-plugin = "^3.1.4"

[tool.poetry.extras]
docs = [
"mkdocstrings",
"mkdocs-include-markdown-plugin"
]

[tool.black]
line-length = 120
Expand Down