From b6f923399fac874f89790a8f899c6aafd0ffb2a8 Mon Sep 17 00:00:00 2001 From: Swann Martinez Date: Thu, 16 Jan 2020 12:04:33 +0100 Subject: [PATCH] feat: documentation base structure Related to #51 --- docs/conf.py | 17 ++++++++++++++++- docs/index.rst | 24 ++++++++++++++---------- docs/install.rst | 1 - docs/introduction.rst | 2 ++ 4 files changed, 32 insertions(+), 12 deletions(-) create mode 100644 docs/introduction.rst diff --git a/docs/conf.py b/docs/conf.py index 141bf4d..9845a0d 100644 --- a/docs/conf.py +++ b/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. @@ -80,4 +92,7 @@ notfound_context = {

Sorry, we couldn't find that page.

Try using the search box or go to the homepage.

''', -} \ No newline at end of file +} + +# Enable directives that insert the contents of external files +file_insertion_enabled = False \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 2b3e14b..dd96499 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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` diff --git a/docs/install.rst b/docs/install.rst index cce8a0d..a7578a6 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,4 +1,3 @@ -============ Installation ============ diff --git a/docs/introduction.rst b/docs/introduction.rst new file mode 100644 index 0000000..c516b33 --- /dev/null +++ b/docs/introduction.rst @@ -0,0 +1,2 @@ +Introduction +============