Skip to content
This repository has been archived by the owner on Sep 10, 2022. It is now read-only.

Sphinxify wiki #181

Open
agraubert opened this issue Oct 26, 2018 · 1 comment
Open

Sphinxify wiki #181

agraubert opened this issue Oct 26, 2018 · 1 comment

Comments

@agraubert
Copy link
Owner

It would be nice to copy the api documentation into docstrings so they're accessible at runtime

@agraubert agraubert added this to the Overhaul Repo milestone May 22, 2019
@agraubert
Copy link
Owner Author

This issue will have 2 parts

Part 1: Move the wiki documentation into docstrings

  • Remember to add sphinx formatting to all docs

Part 2: Enable Sphinx wiki

  • Host docs from a github.io page in gh_pages directory (or similar) on master
    • If docs aren't updated during release, they can be by posting a [ci skip] commit to master
  • Remove old wiki, and redirect

@agraubert agraubert changed the title Maintenance: Add wiki elements to docstrings Sphinxify wiki May 22, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant