Skip to content

Configure Read The Docs#251

Merged
frostming merged 4 commits into
python-poetry:masterfrom
webknjaz:maintenance/rtd-config
Nov 9, 2022
Merged

Configure Read The Docs#251
frostming merged 4 commits into
python-poetry:masterfrom
webknjaz:maintenance/rtd-config

Conversation

@webknjaz
Copy link
Copy Markdown
Contributor

@webknjaz webknjaz commented Nov 9, 2022

This patch includes minimal configuration and fixes for the Sphinx warnings, making it possible to make the RTD builds succeed.

Fixes #161

Build log in the fork: https://readthedocs.org/projects/tomlkit-webknjazs-fork/builds/18578470/
Demo: https://tomlkit-webknjazs-fork.readthedocs.io/en/maintenance-rtd-config/

@webknjaz webknjaz changed the title Add a ReadTheDocs config file Configure Read The Docs Nov 9, 2022
@webknjaz webknjaz mentioned this pull request Nov 9, 2022
@frostming
Copy link
Copy Markdown
Contributor

frostming commented Nov 9, 2022

While the readthedocs site is running, I don't have sufficient permission to setup the hook to trigger the doc build on every commit. @sdispater Can you help to add? I've added you as maintainer.

@frostming frostming merged commit 93bec6f into python-poetry:master Nov 9, 2022
@webknjaz
Copy link
Copy Markdown
Contributor Author

webknjaz commented Nov 9, 2022

@sdispater also, tick the checkbox for making the PR builds.

@frostming
Copy link
Copy Markdown
Contributor

@sdispater also, tick the checkbox for making the PR builds.

Done, I just lack of github permission to add integration(webhooks)

@webknjaz
Copy link
Copy Markdown
Contributor Author

webknjaz commented Nov 9, 2022

@frostming ah, so you may want to also link https://tomlkit.rtfd.io from the repo Code tab's right sidebar, from the README and from the package metadata (PyPI shows what you put into the project_urls in the project's left sidebar).

capuanob pushed a commit to capuanob/tomlkit that referenced this pull request Mar 1, 2023
* Add a ReadTheDocs config file

* Make the link unnamed

* Drop the duplicate module entry in Sphinx docs

* Stop referring to a non-existent static dir in doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a doc site

2 participants