##// END OF EJS Templates
Merge pull request #12739 from farisachugthai/conda
Merge pull request #12739 from farisachugthai/conda

File last commit:

r26052:41c649ba
r26260:6a7c4880 merge
Show More
README.rst
64 lines | 1.8 KiB | text/x-rst | RstLexer
Paul Ivanov
README now includes description of make targets
r12939 IPython Documentation
---------------------
fperez
Reorganized the directory for ipython/ to have its own dir, which is a bit...
r0
Matthias Bussonnier
Update release instruction...
r22667 This directory contains the majority of the documentation for IPython.
Paul Ivanov
README now includes description of make targets
r12939
Doug Latornell
Add docs about building the docs....
r24060
Matthias Bussonnier
more docs on building docs
r20903 Deploy docs
-----------
Matthias Bussonnier
Update release instruction...
r22667 Documentation is automatically deployed on ReadTheDocs on every push or merged
Pull requests.
Matthias Bussonnier
more docs on building docs
r20903
Paul Ivanov
README now includes description of make targets
r12939 Requirements
------------
Doug Latornell
Add docs about building the docs....
r24060
The documentation must be built using Python 3.
Matthias Bussonnier
Update docs/README.rst
r26052 In addition to :ref:`devinstall`,
Doug Latornell
Improve local docs building docs to ensure all dependencies are installed.
r24077 the following tools are needed to build the documentation:
Paul Ivanov
README now includes description of make targets
r12939
Matthias Bussonnier
Update release instruction...
r22667 - sphinx
Doug Latornell
Add docs about building the docs....
r24060 - sphinx_rtd_theme
Doug Latornell
Improve local docs building docs to ensure all dependencies are installed.
r24077 - docrepr
Paul Ivanov
README now includes description of make targets
r12939
Doug Latornell
Improve local docs building docs to ensure all dependencies are installed.
r24077 In a conda environment, or a Python 3 ``venv``, you should be able to run::
Paul Ivanov
README now includes description of make targets
r12939
Doug Latornell
Improve local docs building docs to ensure all dependencies are installed.
r24077 cd ipython
pip install -U -r docs/requirements.txt
Doug Latornell
Add docs about building the docs....
r24060
Build Commands
--------------
Paul Ivanov
README now includes description of make targets
r12939
The documentation gets built using ``make``, and comes in several flavors.
Matthias Bussonnier
Update release instruction...
r22667 ``make html`` - build the API and narrative documentation web pages, this is
the default ``make`` target, so running just ``make`` is equivalent to ``make
html``.
Paul Ivanov
README now includes description of make targets
r12939
Matthias Bussonnier
Update release instruction...
r22667 ``make html_noapi`` - same as above, but without running the auto-generated API
docs. When you are working on the narrative documentation, the most time
Daniel Mietchen
copyedits
r26050 consuming portion of the build process is the processing and rendering of the
Paul Ivanov
README now includes description of make targets
r12939 API documentation. This build target skips that.
``make pdf`` will compile a pdf from the documentation.
You can run ``make help`` to see information on all possible make targets.
Doug Latornell
Add note about docs build inclusion in Travis-CI builds.
r24061
Doug Latornell
Add note about how to do clean docs builds.
r24062 To save time,
luz.paz
Fix documentation typos...
r24322 the make targets above only process the files that have been changed since the
Doug Latornell
Add note about how to do clean docs builds.
r24062 previous docs build.
To remove the previous docs build you can use ``make clean``.
J Forde
Update README.rst...
r24063 You can also combine ``clean`` with other `make` commands;
Doug Latornell
Add note about how to do clean docs builds.
r24062 for example,
Daniel Mietchen
copyedits
r26050 ``make clean html`` will do a complete rebuild of the docs or ``make clean pdf`` will do a complete build of the pdf.
Doug Latornell
Add note about how to do clean docs builds.
r24062
Doug Latornell
Add note about docs build inclusion in Travis-CI builds.
r24061
Continuous Integration
----------------------
Documentation builds are included in the Travis-CI continuous integration process,
so you can see the results of the docs build for any pull request at
https://travis-ci.org/ipython/ipython/pull_requests.