File tree 1 file changed +10
-2
lines changed
1 file changed +10
-2
lines changed Original file line number Diff line number Diff line change @@ -70,9 +70,10 @@ Then we build the proper backend code for the type of documentation you've selec
70
70
If you have the *Install Project * option enabled, we will run ``setup.py install `` on your package, installing it into a virtual environment.
71
71
You can also define additional packages to install with the *Requirements File * option.
72
72
73
- When we build your documentation, we run ``sphinx-build -b html . _build/html ``,
73
+ When we build your Sphinx documentation, we run ``sphinx-build -b html . _build/html ``,
74
74
where ``html `` would be replaced with the correct backend.
75
75
We also create pdf's and ePub's automatically based on your project.
76
+ For MkDocs, we run ``mkdocs build ``.
76
77
77
78
Then these files are copied across to our application servers from the build server.
78
79
Once on the application servers, they are served from nginx.
@@ -88,7 +89,14 @@ An example in code:
88
89
run(' pip install -r %s ' % project.requirements_file)
89
90
build_docs(version = version)
90
91
copy_files(artifact_dir)
91
-
92
+
93
+ .. note ::
94
+
95
+ Regardless of whether you build your docs with Sphinx or MkDocs,
96
+ we recommend you pin the version of Sphinx or Mkdocs you want us to use.
97
+ You can do this the same way other
98
+ :doc: `dependencies are specified <guides/specifying-dependencies >`.
99
+ Some examples of pinning versions might be ``sphinx<2.0 `` or ``mkdocs>=1.0 ``.
92
100
93
101
Builder responsibility
94
102
----------------------
You can’t perform that action at this time.
0 commit comments