-
Notifications
You must be signed in to change notification settings - Fork 7
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
Conversation
getting sphinx-gallery working woops
There was a problem hiding this 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 = { |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
requirements-doc.txt & requirements-dev.txt defined thanks for the review @nicain !! If you can sign off, I can merge. |
merging since nick's requests have been implemented |
this PR implements the tooling needed to maintain documentation