@@ -47,8 +47,11 @@ The options are:
4747* `'google_analytics' ` : str, your Google analytics ID, if any.
4848* `'nav_links' ` : tuple list, a list of ('Link display name', 'local.file'), contains the links to the local documentation, in the top navigation bar.
4949* `'external_nav_links' ` : same as above but contains external links.
50+ * `'external_nav_links_dropdown' ` : same as above but contains multiple links in a dropdown.
51+ In that case, `'external_nav_links_dropdown_title' ` indicates the text of the dropdown button.
5052
51- Example:
53+
54+ **Example: **
5255
5356.. code :: rst
5457
@@ -57,17 +60,21 @@ Example:
5760 'nav_links' : [('Install', 'installation'),
5861 ('User Guide', 'user_guide/index')]
5962 'external_nav_links' : [('TensorLy', 'https://github.com/tensorly/tensorly'),
60- ('TensorLy-Torch', 'https://github.com/tensorly/torch')]
61- }
63+ ('TensorLy-Torch', 'https://github.com/tensorly/torch')],
64+ 'external_nav_links_dropdown_title': 'LinksInDropdown',
65+ 'external_nav_links_dropdown' : [('TensorLy', 'http://tensorly.org/dev'),
66+ ('TensorLy-Viz', 'http://tensorly.org/viz'),
67+ ('TensorLy-Quantum', 'http://tensorly.org/quantum')],
68+ }
6269
6370
6471In rst files
6572------------
6673
67- In your documentation itself, you can use `no-toc `, :no-localtoc: and `no-pagination `
74+ In your documentation itself, you can use `` : no-toc: ``, `` :no-localtoc: `` and `` : no-pagination: ``
6875to remove the side-menu's table of content (toc), local toc ("on this page")
6976and pagination buttons, respectively.
70- For instance, if you don't want `file.rst ` to have a toc, simply add in the file:
77+ For instance, if you don't want `` file.rst ` ` to have a toc, simply add in the file:
7178
7279.. code ::
7380
0 commit comments