Skip to content

Commit 3ffa372

Browse files
Add version picker section to getting started guide
* docs/sphinx/guide/getting-started.rst : Add section about adding a version picker to your docs to the getting stared guide.
1 parent b6648ba commit 3ffa372

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

docs/sphinx/guide/getting-started.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,10 +315,22 @@ Overriding config options
315315

316316
You can override the defaults set in `poly.py` by specifying values on the
317317
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`.
319319
All other variables can be overidden through the :code:`-o` flag. You can
320320
override the arguments passed to `sphinx-build` by entering the following:
321321

322322
.. code-block:: bash
323323
324324
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

0 commit comments

Comments
 (0)