feat: documentation base structure

Related to #51
This commit is contained in:
Swann Martinez
2020-01-16 12:04:33 +01:00
parent c2fe5c456b
commit b6f923399f
4 changed files with 32 additions and 12 deletions

View File

@ -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.
@ -80,4 +92,7 @@ notfound_context = {
<p>Sorry, we couldn't find that page.</p>
<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

View File

@ -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`

View File

@ -1,4 +1,3 @@
============
Installation
============

2
docs/introduction.rst Normal file
View File

@ -0,0 +1,2 @@
Introduction
============