15
docs/conf.py
15
docs/conf.py
@ -66,6 +66,18 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
||||
if on_rtd:
|
||||
using_rtd_theme = True
|
||||
|
||||
# Theme options
|
||||
html_theme_options = {
|
||||
# 'typekit_id': 'hiw1hhg',
|
||||
# 'analytics_id': '',
|
||||
# 'sticky_navigation': True # Set to False to disable the sticky nav while scrolling.
|
||||
# 'logo_only': True, # if we have a html_logo below, this shows /only/ the logo with no title text
|
||||
#'collapse_navigation': False, # Collapse navigation (False makes it tree-like)
|
||||
# 'display_version': True, # Display the docs version
|
||||
# 'navigation_depth': 4, # Depth of the headers shown in the navigation bar
|
||||
}
|
||||
|
||||
|
||||
# -- Options for HTMLHelp output ------------------------------------------
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
@ -81,3 +93,6 @@ notfound_context = {
|
||||
<p>Try using the search box or go to the homepage.</p>
|
||||
''',
|
||||
}
|
||||
|
||||
# Enable directives that insert the contents of external files
|
||||
file_insertion_enabled = False
|
@ -3,19 +3,23 @@
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to multi-user's documentation!
|
||||
======================================
|
||||
Multi-user's documentation
|
||||
==========================
|
||||
|
||||
Welcome to the multi-user documentation !
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: About
|
||||
:name: sec-about
|
||||
|
||||
introduction
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Getting started
|
||||
:name: sec-learn
|
||||
|
||||
install
|
||||
quickstart
|
||||
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
@ -1,4 +1,3 @@
|
||||
============
|
||||
Installation
|
||||
============
|
||||
|
||||
|
2
docs/introduction.rst
Normal file
2
docs/introduction.rst
Normal file
@ -0,0 +1,2 @@
|
||||
Introduction
|
||||
============
|
Reference in New Issue
Block a user