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

documentation tooling #41

Merged
merged 4 commits into from
Nov 19, 2017
Merged

documentation tooling #41

merged 4 commits into from
Nov 19, 2017

Conversation

neuromusic
Copy link
Contributor

@neuromusic neuromusic commented Nov 9, 2017

this PR implements the tooling needed to maintain documentation

@neuromusic neuromusic changed the title [WIP] documentation documentation tooling Nov 18, 2017
getting sphinx-gallery working


woops
Copy link
Contributor

@nicain nicain left a comment

Choose a reason for hiding this comment

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

You should add a requirement-dev and requirements-doc that include sphinx-related imports

Tons of work! Looks good

docs/conf.py Outdated
@@ -153,7 +194,17 @@
#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# html_sidebars = {}
# html_sidebars = {
Copy link
Contributor

Choose a reason for hiding this comment

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

This looks like a typo to me; repeated html_sidebars twice

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

docs/conf.py Outdated
# this is needed for some reason...
# see https://github.com/numpy/numpydoc/issues/69
# numpydoc_class_members_toctree = False
# class_members_toctree = False
Copy link
Contributor

Choose a reason for hiding this comment

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

Delete all of this commented out code?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@neuromusic
Copy link
Contributor Author

requirements-doc.txt & requirements-dev.txt defined

thanks for the review @nicain !! If you can sign off, I can merge.

@neuromusic
Copy link
Contributor Author

merging since nick's requests have been implemented

@neuromusic neuromusic merged commit e737a55 into AllenInstitute:master Nov 19, 2017
@neuromusic neuromusic deleted the feature/docs branch November 20, 2017 22:35
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.

2 participants