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

Host docs using Github Pages #171

Closed
ranisalt opened this issue Aug 11, 2018 · 1 comment · Fixed by #329
Closed

Host docs using Github Pages #171

ranisalt opened this issue Aug 11, 2018 · 1 comment · Fixed by #329
Labels
type: documentation Related to the documentation

Comments

@ranisalt
Copy link

I see that documentation is available at /docs. Coincidentally, that's exactly one of the options where Github can automatically serve pages:

image

Please do this, so that documentation is available at pdfminer.github.io/pdfminer.six

@pietermarsman pietermarsman added the type: documentation Related to the documentation label Oct 13, 2019
@pietermarsman
Copy link
Member

I've started working on sphinx documentation on the documentation branch. It is published on readthedocs.

Keep in mind: work in progress, help is appreciated.

pietermarsman added a commit that referenced this issue Nov 7, 2019
Fixes #171
Fixes #199
Fixes #118
Fixes #178
Added: tests for building documentation and example code in documentation
Added: docstrings for common used functions and classes
Removed: old documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Related to the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants