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

[WIP]Only execute codefolding preprocessor when requested #794

Merged
merged 7 commits into from
Nov 27, 2016

Conversation

juhasch
Copy link
Member

@juhasch juhasch commented Nov 15, 2016

  • Only execute preprocessor when configuration variable is set
  • add test
  • add documentation

Addresses #792

@juhasch
Copy link
Member Author

juhasch commented Nov 15, 2016

@jcb91 : I would like to move the autoclass API docs to a separate chapter internals, and instead only have the description on how to use the different exporters, pre- and preprocessors under exporting ?

@jcb91
Copy link
Member

jcb91 commented Nov 15, 2016

I would like to move the autoclass API docs to a separate chapter internals, and instead only have the description on how to use the different exporters, pre- and preprocessors under exporting?

Sure, seems like a sensible move. I think we even already have an internals file :)

@juhasch
Copy link
Member Author

juhasch commented Nov 18, 2016

Is there any deeper meaning why exporting.rst is rst and internals.md is md format ?
Otherwise I will convert the internals stuff to rst.

@jcb91
Copy link
Member

jcb91 commented Nov 21, 2016

Is there any deeper meaning why exporting.rst is rst and internals.md is
md format ?
Otherwise I will convert the internals stuff to rst.

No, I just kept to markdown for anything that didn't require rst-only
features, to make it easier to compare with the main (markdown) readme.
Convert away :)

============================

The nbextensions are stored each as a separate subdirectory of
`src/jupyter_contrib_nbextensions/nbextensions`
Copy link
Member

Choose a reason for hiding this comment

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

in rst, inline literals may need two backticks? I believe the notebook repo has somehow enabled use of single backticks, but I'm not sure how. The only reference to single backticks that I can find is this, which seems to suggest that by default, single backticks have no special meaning

Copy link
Member

Choose a reason for hiding this comment

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

it seems the single backticks give the default role, which is configurable. Perhaps we should add a

default_role = 'code'

to conf.py?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good catch. Yes, I think we should set the default role.

@juhasch
Copy link
Member Author

juhasch commented Nov 27, 2016

@jcb91 Any idea why one test fails ? I don't see how my changes would affect it.

@jcb91
Copy link
Member

jcb91 commented Nov 27, 2016 via email

@juhasch juhasch merged commit f11cd4f into ipython-contrib:master Nov 27, 2016
@juhasch juhasch deleted the fix/codefolding branch January 6, 2017 22:07
@juhasch juhasch restored the fix/codefolding branch January 8, 2017 15:13
@juhasch juhasch deleted the fix/codefolding branch February 11, 2017 09:06
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