updating documentation
This commit is contained in:
@@ -39,6 +39,7 @@ extensions = [
|
||||
'sphinx.ext.napoleon',
|
||||
'sphinx.ext.todo',
|
||||
'sphinx_click.ext',
|
||||
'sphinx.ext.intersphinx'
|
||||
]
|
||||
|
||||
# -- Napoleon Settings -----------------------------------------------------
|
||||
@@ -60,7 +61,7 @@ autodoc_member_order = 'bysource'
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'introduction'
|
||||
master_doc = 'index'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
|
||||
@@ -1,3 +1,13 @@
|
||||
=============
|
||||
Introduction
|
||||
=============
|
||||
|
||||
#####
|
||||
Test
|
||||
#####
|
||||
|
||||
testing
|
||||
|
||||
test code::
|
||||
|
||||
some test code
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
self
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Overview
|
||||
:titlesonly:
|
||||
|
||||
@@ -7,14 +11,14 @@
|
||||
changelog
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 2
|
||||
:caption: Modules
|
||||
:titlesonly:
|
||||
|
||||
modules/musicbrainzapi.rst
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 2
|
||||
:caption: Submodules
|
||||
:titlesonly:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user