File tree Expand file tree Collapse file tree 1 file changed +13
-1
lines changed Expand file tree Collapse file tree 1 file changed +13
-1
lines changed Original file line number Diff line number Diff line change @@ -315,10 +315,22 @@ Overriding config options
315
315
316
316
You can override the defaults set in `poly.py ` by specifying values on the
317
317
commandline. Specifying an output location will override :code: `OUTPUT_DIR ` while
318
- specifying `--local ` will set :code: `MOCK ` to `True `.
318
+ specifying :code: `--local ` will set :code: `MOCK ` to :code: `True `.
319
319
All other variables can be overidden through the :code: `-o ` flag. You can
320
320
override the arguments passed to `sphinx-build ` by entering the following:
321
321
322
322
.. code-block :: bash
323
323
324
324
sphinx-polyversion docs/poly.py -o SPHINX_BUILD=' -T -v'
325
+
326
+
327
+ Adding a version picker to the docs
328
+ -----------------------------------
329
+
330
+ There are plenty of ways how to add a widget to your rendered documentation that allows
331
+ the user to select the version to view. Some themes might come with a version picker build-in
332
+ while for the others you have to add one yourself. Usually you can leverage sphinx template
333
+ system for that. For a reference you can have a look how this documentation implemented
334
+ the version picker.
335
+
336
+ .. TODO link relevant code
You can’t perform that action at this time.
0 commit comments