-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
3a0687d
Update docs about build process
stsewd 9475637
Use double backtips
stsewd 7720f6f
Add note about pre installed libs
stsewd 2bafef5
Add tip about packages versions
stsewd ee9ab1a
Sort packages
stsewd 2f7c208
Fix sentence
stsewd File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
|
||
Then these files are copied across to our application servers from the build server. | ||
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Final dot: There was a problem hiding this comment. Choose a reason for hiding this commentThe 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) | ||
~~~~~~~~~~~~ | ||
|
@@ -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>`__ | ||
|
||
|
@@ -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>`__ | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.There was a problem hiding this comment.
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 and
html` here?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah