Skip to content
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.

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

Generate and publish documentation #78

Open
akaihola opened this issue Sep 12, 2020 · 0 comments
Open

Generate and publish documentation #78

akaihola opened this issue Sep 12, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@akaihola
Copy link
Owner

Black has Sphinx documentation auto-generated from the extensive README.md file. The documentation is then published on readthedocs.io.

We could do the same, but since our README.rst is ReStructuredText like Sphinx documentation by default, we could use the .. include:: directive with the start-after and end-before options to include parts of the README in correct documentation sections, instead of running custom code to extract the text.

@akaihola akaihola added the documentation Improvements or additions to documentation label Sep 16, 2020
@akaihola akaihola added this to the 1.4.0 milestone Sep 4, 2021
@akaihola akaihola modified the milestones: 1.4.0, 1.4.1 Oct 31, 2021
@akaihola akaihola modified the milestones: 1.4.1, 1.5.0 Feb 10, 2022
@akaihola akaihola modified the milestones: 1.5.0, 1.6.0 Mar 30, 2022
@akaihola akaihola modified the milestones: 1.6.0, 1.6.1, 1.8.0 Dec 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

1 participant