Update docs about build process #4515
Conversation
Describe each docker image used to build the docs
docs/builds.rst
Outdated
| 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 man pages and pdf's automatically based on your project. | ||
| 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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Don't we need double for the command andhtml` here?
docs/builds.rst
Outdated
| * ``graphviz`` | ||
| * ``pandoc`` | ||
| * ``doxygen`` | ||
| * ``libjpeg`` |
There was a problem hiding this comment.
Not sure if all these packages are relevant, I keep the most that were in the previous description
| Packages installed in the build environment | ||
| ------------------------------------------- | ||
|
|
||
| The build server 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. We currently have the following libraries installed: |
There was a problem hiding this comment.
I'd keep a message similar to this one inside a .. note:: so, users are aware that we can't install everything inside the docker image.
docs/builds.rst
Outdated
| 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. |
There was a problem hiding this comment.
I'd add a .. tip:: admonition here with indicating how to verify the version of each package installed in the docker image (linking to https://packages.ubuntu.com/ for each specific version and commenting how to do it)
docs/builds.rst
Outdated
| * ``graphviz`` | ||
| * ``pandoc`` | ||
| * ``doxygen`` | ||
| * ``libjpeg`` |
docs/builds.rst
Outdated
| 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 |
Describe each docker image used to build the docs
ref to #4419 (comment)