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

Documentation improvements #311

Closed
4 tasks done
tbenthompson opened this issue Aug 18, 2020 · 2 comments
Closed
4 tasks done

Documentation improvements #311

tbenthompson opened this issue Aug 18, 2020 · 2 comments

Comments

@tbenthompson
Copy link
Collaborator

tbenthompson commented Aug 18, 2020 •
edited by MargueriteBastaQC
Loading

  • Liz or Marc should look through and edit/improve the Readme.
  • We should add some useful instructions to the Sphinx page. Possibly installation and quick start. Alternatively, it can just be a copy of the main Readme.
  • Remove glm_benchmarks from the public API in Sphinx.
  • Fix strange Sphinx format the API page hierarchy
@tbenthompson
Copy link
Collaborator Author

@MargueriteBastaQC I think you've fixed some of the issues here!

@MargueriteBastaQC
Copy link
Contributor

Moving to done for now. API page hierarchy could still be improved (would be nice if the dropdown from the API reference was just each of the external facing API functions/classes), but looks like this might not be possible until this sphinx issue is fixed: sphinx-doc/sphinx#6316

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tbenthompson @MargueriteBastaQC