-
Notifications
You must be signed in to change notification settings - Fork 557
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
Machinery for building the documentation #1
Conversation
The test failures are not related to this - it's trying to import the notebook, and not finding it. Adding a dependency on the notebook seems like the wrong thing to do given that the notebook already depends on nbconvert. I'm not sure why it wasn't failing before. |
@@ -1,2 +1,41 @@ | |||
version_info = (4, 0, 0, 'dev') | |||
__version__ = '.'.join(map(str, version_info)) |
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.
I think I'd rather keep this file small and simple, and just add _version_extra
to check for the 'dev' tag.
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.
I would have preferred to leave it how it was, actually.
ed0d037
to
cb036dd
Compare
@takluyver Done! :) |
Thanks! |
Machinery for building the documentation
@@ -1,2 +1,3 @@ | |||
version_info = (4, 0, 0, 'dev') | |||
_version_extra = 'dev' | |||
version_info = (4, 0, 0, _version_extra) |
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 will do the wrong thing at release time when _version_extra is empty. My plan for this was to have a release replace this with version_info = (4, 0, 0)
, having no extra at all.
If version_extra is to be treated as a variable, it needs to be conditionally added to version_info only if it's non-empty.
If this is prompted by the _version_extra logic in conf.py, I would prefer to remove that logic, rather than change this here.
It looks like the sphinx conf.py was copied from IPython rather than started fresh, and I think perhaps we should avoid that. There are a lot of things we've accumulated in IPython over the years that we don't necessarily want to inherit in the new projects. |
Sorry, I was a bit too eager with the merge button. |
No problem, it's good to get these off the ground. I just want to make sure everything we copy over from IPython we actually want to inherit. Lots of the docs stuff is super old. |
The people copying over the docs stuff did go through conf.py and remove several bits that we don't want to inherit - e.g. there shouldn't be a need to special-case Readthedocs. I guess there were always going to be some bits we missed, though. |
Machinery for building the documentation
Simplify code to get exporter instance
remove UUID, and undefined variable
Update notebook CSS from 4.3.0 to 5.1.0
No description provided.