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.

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

Jump to bottom

Generate documentation with Sphinx and use Read the Docs #141

Merged
merged 10 commits into from
Sep 27, 2021
Merged

Generate documentation with Sphinx and use Read the Docs #141

merged 10 commits into from
Sep 27, 2021

Conversation

tristanlatr
Copy link
Collaborator

@tristanlatr tristanlatr commented Sep 18, 2021 •
edited by ssbarnea
Loading

This adds a simple setup to generate documentation with sphinx and use readthedocs.

@tristanlatr
Copy link
Collaborator Author

Demo: https://ansi2html--141.org.readthedocs.build/

@tristanlatr
Copy link
Collaborator Author

tristanlatr commented Sep 18, 2021 •
edited
Loading

The lint step seems really zealous... I'll let you fix it.

Edit: ok it fixes the thing itself when running it locally. So that's Ok.

@tristanlatr tristanlatr added the docs This issue/PR relates to or includes documentation. label Sep 18, 2021
@tristanlatr tristanlatr mentioned this pull request Sep 20, 2021
Closed
@ssbarnea ssbarnea added the enhancement This issue/PR relates to a feature request. label Sep 27, 2021
@ssbarnea ssbarnea merged commit 3984825 into main Sep 27, 2021
@ssbarnea ssbarnea deleted the sphinx-docs branch September 27, 2021 15:35
@ziegenberg ziegenberg changed the title Sphinx docs Generate documentation with Sphinx and use Read the Docs Nov 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ssbarnea ssbarnea ssbarnea approved these changes

Assignees
No one assigned
Labels
docs This issue/PR relates to or includes documentation. enhancement This issue/PR relates to a feature request.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tristanlatr @ssbarnea