Skip to content

get documentation building#3

Closed
justinkao wants to merge 3 commits intoipython:masterfrom
justinkao:docs
Closed

get documentation building#3
justinkao wants to merge 3 commits intoipython:masterfrom
justinkao:docs

Conversation

@justinkao
Copy link
Copy Markdown

  • add sphinx build files for documentation
  • copied over some style and template files from the main IPython repo
  • modify _version.py to contain more version info
  • move examples/Parallel Computing down into examples/ and update links
  • move docs/source/parallel down into docs/source
  • make in the docs/ directory now generates html output

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you revert the changes in _version_.py, please and leave it how it was? It was like that for a reason.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

The conf script for ipython uses _version_extra to insert a disclaimer:
https://github.com/ipython/ipython/blob/master/docs/source/conf.py#L72

I wanted to also support this, should I take it out?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

See what we did for nbconvert - left it basically the same but added _version_extra:

https://github.com/jupyter/jupyter_nbconvert/pull/1/files#diff-d7781741d938b7b8e52a1059d3772880

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I would indeed take out the check for version_extra in conf.py and leave _version.py exactly how it is.

@minrk minrk changed the title fix documentation building get documentation building Apr 13, 2015
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This can be replaced with _version.version_info[-1] == 'dev'. There is no need for any changes in _version.py

@minrk
Copy link
Copy Markdown
Member

minrk commented Apr 20, 2015

copied over some style and template files from the main IPython repo

let's not inherit any style or templates from IPython. That stuff is super old.

@minrk
Copy link
Copy Markdown
Member

minrk commented Apr 20, 2015

@justinkao are you planning to address comments on this, or should we finish it up?

@minrk minrk mentioned this pull request Apr 20, 2015
@minrk
Copy link
Copy Markdown
Member

minrk commented Apr 20, 2015

Finished up in #5

@minrk minrk closed this in #5 Apr 20, 2015
@justinkao justinkao deleted the docs branch April 21, 2015 17:54
@minrk minrk modified the milestone: no action Jun 7, 2016
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.

3 participants