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

Update docs about build process #4515

Merged
merged 6 commits into from
Aug 21, 2018
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 26 additions & 16 deletions docs/builds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ Then we build the proper backend code for the type of documentation you've selec
If you have the *Install Project* option enabled, we will run ``setup.py install`` on your package, installing it into a virtual environment.
You can also define additional packages to install with the *Requirements File* option.

When we build your documentation, we run `sphinx-build -b html . _build/html`,
where `html` would be replaced with the correct backend.
When we build your documentation, we run ``sphinx-build -b html . _build/html``,
where ``html`` would be replaced with the correct backend.
We also create pdf's and ePub's automatically based on your project.
Copy link
Member Author

Choose a reason for hiding this comment

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

The rest of the lines are the same, they were just too long. Except here, here we have had man pages, but we don't build man pages anymore.

Copy link
Member

Choose a reason for hiding this comment

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

Don't we need double for the command andhtml` here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah


Then these files are copied across to our application servers from the build server.
Expand Down Expand Up @@ -102,7 +102,17 @@ The build process is executed inside Docker containers,
by default the image used is ``readthedocs/build:2.0``,
but you can change that using a :doc:`configuration file <yaml-config>`.

Each image is described below.
.. note::

The Docker image does have a select number of C libraries installed,
because they are used across a wide array of python projects.
We can't install every C library out there,
but we try and support the major ones
Copy link
Member

Choose a reason for hiding this comment

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

Final dot: .

Copy link
Member Author

Choose a reason for hiding this comment

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

😭


.. tip::

If you want to know the specific version of a package that is installed in the image
you can check the `Ubuntu package search page <https://packages.ubuntu.com/>`__.

2.0 (stable)
~~~~~~~~~~~~
Expand All @@ -113,18 +123,18 @@ Each image is described below.
* ``m2crypto``
* ``matplolib``
* ``numpy``
* ``scipy``
* ``pandas``
* ``pip``
* ``scipy``
:Other packages:
* ``doxygen``
* ``graphviz``
* ``libevent``
* ``libjpeg``
* ``libxml2-dev``
* ``libxslt1.1``
* ``libevent``
* ``textlive-full``
* ``graphviz``
* ``pandoc``
* ``doxygen``
* ``libjpeg``
* ``textlive-full``

`More details <https://github.com/rtfd/readthedocs-docker-images/blob/releases/2.x/Dockerfile>`__

Expand All @@ -136,23 +146,23 @@ Each image is described below.
:Python:
* ``matplolib``
* ``numpy``,
* ``scipy``
* ``pandas``
* ``pip``
* ``scipy``
:JavaScript:
* ``jsdoc``
* ``nodejs``
* ``npm``
* ``jsdoc``
:Other packages:
* ``libxml2-dev``
* ``libxslt1-dev``
* ``doxygen``
* ``libevent-dev``
* ``textlive-full``
* ``libgraphviz-dev``
* ``pandoc``
* ``doxygen``
* ``libjpeg``
* ``libxml2-dev``
* ``libxslt1-dev``
* ``pandoc``
* ``plantuml``
* ``textlive-full``

`More details <https://github.com/rtfd/readthedocs-docker-images/blob/releases/3.x/Dockerfile>`__

Expand Down