Alexander/FitTrackee
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add api auto generate documentation

Browse Source
This commit is contained in:
Sam 2019-07-14 14:59:44 +02:00
parent 5c13dec256
commit dd04386743
3 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/api/endpoints.rst Normal file
View File

@ -0,0 +1,4 @@
FitTrackee API documentation
############################
.. autoflask:: fittrackee_api:create_app()

7
docs/source/conf.py
View File

@ -10,10 +10,10 @@
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.
# #
# import os import os
# import sys import sys
# sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('../../fittrackee_api'))
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
@ -31,6 +31,7 @@ release = '0.2.1-beta'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = [
'sphinxcontrib.autohttp.flask'
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.

2
docs/source/index.rst
View File

@ -10,7 +10,7 @@ Welcome to FitTrackee's documentation!
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
api/endpoints
Indices and tables Indices and tables
================== ==================