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

Feature request: reference website #33

Closed
mhoffman opened this issue Apr 23, 2015 · 2 comments
Closed

Feature request: reference website #33

mhoffman opened this issue Apr 23, 2015 · 2 comments

Comments

@mhoffman
Copy link
Contributor

For 'advanced beginners' it would be really useful to have a single website for an as complete as possible class, function, and attribute level documentation on a single reference website. I'll just throw this example out there as how this could look like. The advantage of this is that one can simply Ctrl+F for a certain feature and immediately glean from it in which file or submodule to look.

Keeping such a reference is made easy both initially and maintaining it as well. And I briefly outline the steps required:

  1. open an account on https://readthedocs.org/accounts/signup/
  2. create stub files for each submodule in a documentation folder for sphinx.autodoc
  3. create a webhook inside the github repository which triggers in generation of the HTML documentation on each merge into e.g. the master branch.

If @ajmedford would initiate step 1. & 3. I will be more than happy to contribute step 2., maybe next Wednesday?

@ajmedford
Copy link
Collaborator

This sounds like a great idea. I will get it set up before we meet next Wednesday.

@mhoffman
Copy link
Contributor Author

mhoffman commented May 6, 2015

Oh, wow, seems like idea has been picked up. So much docs to read. Everybody who comes across it: please feel free to submit pull requests for docstrings and such. More about writing strings for Sphinx and be found here

@mhoffman mhoffman closed this as completed May 6, 2015
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

No branches or pull requests

2 participants