Skip to content

Add docs about building the docs. #10912

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
Merged
Carreau merged 4 commits into from
Nov 21, 2017
Merged

Add docs about building the docs. #10912

Carreau merged 4 commits into from
Nov 21, 2017

Conversation

@douglatornell
Copy link
Contributor

@douglatornell douglatornell commented Nov 20, 2017

re: #10895

@jzf2101
Copy link
Contributor

jzf2101 commented Nov 20, 2017 •
edited
Loading

@douglatornell can you explain why we now need sphinx_rtd_theme in addition to build? Also, information regarding our new CI for docs would be appreciated.

@douglatornell
Copy link
Contributor Author

douglatornell commented Nov 20, 2017

@jzf2101 sphinx_rtd_theme is a new dependency because it used to be bundled with sphinx, but a while ago they stopped doing that, so now it has to be installed separately.

I'll add narrative about the sphinx build on travis-ci (pr #10911)

@jzf2101
Copy link
Contributor

jzf2101 commented Nov 20, 2017

could you reverence cleaning builds

@jzf2101
Copy link
Contributor

jzf2101 commented Nov 20, 2017

Thanks!

@douglatornell
Copy link
Contributor Author

douglatornell commented Nov 20, 2017

@jzf2101 Added notes about docs in Travis-CI, and how to do clean builds.

@jzf2101
Update README.rst
3ebca5b 
Adding more specificity based on @douglatornell 's request
@douglatornell douglatornell mentioned this pull request Nov 20, 2017
Closed
@Carreau
Copy link
Member

Carreau commented Nov 21, 2017

Great awesome ! Merging and I'll add an extra comment inline to get your input on a potential extra PR !

@Carreau Carreau merged commit c0783d6 into ipython:master Nov 21, 2017
Carreau
Carreau reviewed Nov 21, 2017
View reviewed changes
docs/README.rst

In a Python 3 ``venv``, you should be able to run::

pip install -U sphinx sphinx_rtd_theme
Copy link
Member

@Carreau Carreau Nov 21, 2017

Choose a reason for hiding this comment

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

I think there is a docs/requirements.txt, maybe pip install --update -r docs/requirements.txt is even more general ? But I think that's already an improvement as is so I already merged ! Thanks !

Copy link
Contributor Author

@douglatornell douglatornell Nov 21, 2017

Choose a reason for hiding this comment

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

Good point! I should have thought of that in light of 326f41b and a couple of other things that happened during the sprint yesterday. I'll work on another PR for this.

Copy link
Contributor

@jzf2101 jzf2101 Nov 21, 2017

Choose a reason for hiding this comment

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

👍

@douglatornell douglatornell mentioned this pull request Nov 21, 2017
Merged
@Carreau Carreau added this to the 7.0 milestone Sep 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Carreau Carreau Carreau left review comments

+1 more reviewer

@jzf2101 jzf2101 jzf2101 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

7.0

Development

Successfully merging this pull request may close these issues.

3 participants

@douglatornell @jzf2101 @Carreau