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

Machinery for building the documentation #1

Merged
merged 1 commit into from
Apr 13, 2015

Conversation

drocco007
Copy link
Contributor

No description provided.

@takluyver
Copy link
Member

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))
Copy link
Member

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.

Copy link
Member

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.

@drocco007
Copy link
Contributor Author

@takluyver Done! :)

@takluyver
Copy link
Member

Thanks!

takluyver added a commit that referenced this pull request Apr 13, 2015
Machinery for building the documentation
@takluyver takluyver merged commit 7fff28b into jupyter:master Apr 13, 2015
@@ -1,2 +1,3 @@
version_info = (4, 0, 0, 'dev')
_version_extra = 'dev'
version_info = (4, 0, 0, _version_extra)
Copy link
Member

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.

@minrk
Copy link
Member

minrk commented Apr 13, 2015

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.

@takluyver
Copy link
Member

Sorry, I was a bit too eager with the merge button.

@minrk
Copy link
Member

minrk commented Apr 14, 2015

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.

@takluyver
Copy link
Member

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.

takluyver added a commit that referenced this pull request Apr 20, 2015
Machinery for building the documentation
@takluyver takluyver modified the milestone: 4.0 Jul 30, 2015
minrk pushed a commit that referenced this pull request Jul 30, 2015
Carreau referenced this pull request in Carreau/nbconvert Jan 7, 2016
minrk pushed a commit that referenced this pull request Jan 17, 2016
Simplify code to get exporter instance
takluyver pushed a commit that referenced this pull request Feb 4, 2016
remove UUID, and undefined variable
mpacer pushed a commit that referenced this pull request Sep 24, 2017
@cyhsu cyhsu mentioned this pull request Oct 21, 2019
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.

None yet

3 participants