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

updating API page #1088

Merged
merged 2 commits into from Aug 19, 2019
Merged

updating API page #1088

merged 2 commits into from Aug 19, 2019

Conversation

choldgraf
Copy link
Contributor

@choldgraf choldgraf commented Aug 19, 2019 •
edited

This does a few small doc updates:

  1. Adds the TagRemovePreprocessor to the API docs
  2. Adds section titles to the API docs to make them a bit easier to parse
  3. Small updates to the docstrings of TagRemovePreprocessor and TemplateExporter

choldgraf
choldgraf commented Aug 19, 2019
View reviewed changes
docs/source/api/preprocessors.rst
@@ -2,6 +2,7 @@ Preprocessors
=============

.. module:: nbconvert.preprocessors
:noindex:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this was because sphinx gave me a warning that this was double-referenced

choldgraf
choldgraf commented Aug 19, 2019
View reviewed changes
nbconvert/preprocessors/tagremove.py
Traitlets
---------
remove_cell_tags
removes cells tagged with these values
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this fixes the rST formatting in the final docs, before it was treating the indentations weirdly so this gets the block quotes rendering properly

MSeal
MSeal approved these changes Aug 19, 2019
View reviewed changes
Copy link
Contributor

@MSeal MSeal left a comment

Choose a reason for hiding this comment

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

Awesome! Thanks for helping fix that

@MSeal MSeal merged commit 2e0baa2 into jupyter:master Aug 19, 2019
@choldgraf choldgraf mentioned this pull request Aug 19, 2019
Merged
@MSeal MSeal added this to the 5.6.1 milestone Oct 21, 2019
@MSeal MSeal added this to the 5.6.1 milestone Sep 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MSeal MSeal MSeal approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
5.6.1
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@choldgraf @MSeal