Skip to content

Add a note about specifying the version of build tools #4562

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

Merged
merged 1 commit into from
Aug 24, 2018
Merged
Changes from all 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
12 changes: 10 additions & 2 deletions docs/builds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,10 @@ 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``,
When we build your Sphinx 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.
For MkDocs, we run ``mkdocs build``.

Then these files are copied across to our application servers from the build server.
Once on the application servers, they are served from nginx.
Expand All @@ -88,7 +89,14 @@ An example in code:
run('pip install -r %s' % project.requirements_file)
build_docs(version=version)
copy_files(artifact_dir)


.. note::

Regardless of whether you build your docs with Sphinx or MkDocs,
we recommend you pin the version of Sphinx or Mkdocs you want us to use.
You can do this the same way other
:doc:`dependencies are specified <guides/specifying-dependencies>`.
Some examples of pinning versions might be ``sphinx<2.0`` or ``mkdocs>=1.0``.

Builder responsibility
----------------------
Expand Down