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

basic documentation #16

Merged
merged 4 commits into from
Apr 11, 2019
Merged

basic documentation #16

merged 4 commits into from
Apr 11, 2019

Conversation

jesteria
Copy link
Member

Changes

  • rounded out library docstrings, such that the heart of the (API) documentation is there
  • integrated with Sphinx (and autodoc)
    • such that standard documentation can be generated from docstrings, (tho HTML currently unused)
    • submitted patches to extension sphinx-contrib.restbuilder, such that Sphinx can also build RST docs – (it's a little surprising that Sphinx can't on its own or otherwise its build process can't be intercepted to retrieve RST formatted output before it's parsed into an abstract tree, considering its input is RST, albeit Sphinx- and autodoc-extended RST; but, nonetheless, this appeared to be the easiest way forward ... though markdown is another obvious target, it doesn't cleanly support all the directives that you get from RST ... and Github won't render README.html).
    • scripted a development command to generate HTML docs and README.rst

In the end, I don't love how the auto-generated README.rst looks, at least not as Github renders it; but, for something like this, I think it's fine, and keeps API documentation in the code.

A discussion of benchmarking the Pandas extension is included in doc/index.rst (and from there included in built documentation).

If this looks reasonable, I'll merge it, and push a new release, such that PyPI gets the README as well.

resolves #1

in (more) proper reStructuredText format

for compatability with Sphinx (integration forthcoming)
README.rst generated from Sphinx docs via patched ``sphinxcontrib.restbuilder``
rather than old README.md
@jesteria jesteria requested review from saleiro and thcrock April 10, 2019 22:10
@jesteria jesteria self-assigned this Apr 10, 2019
Copy link

@thcrock thcrock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I see what you mean about the APIdoc rendering, but it's plenty readable and I've seen (and created) way worse. I think Sphinx's implementation looks better than what I had been using for mkdocs before, so we should look into it for Triage.

@jesteria
Copy link
Member Author

@thcrock Ah cool. Well thanks!

@jesteria jesteria merged commit 819808a into master Apr 11, 2019
@jesteria jesteria deleted the docs branch April 11, 2019 17:07
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.

README / documentation
2 participants