Set up boilerplate sphinx docs

This commit is contained in:
Tanner Collin 2020-01-21 06:18:09 +00:00
parent 3af9f51fb0
commit 72d502d0b7
5 changed files with 147 additions and 0 deletions

20
apiserver/docs/Makefile Normal file
View File

@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

35
apiserver/docs/make.bat Normal file
View File

@ -0,0 +1,35 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd

View File

@ -0,0 +1,53 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# 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.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = 'Spaceport'
copyright = '2020, Tanner Collin'
author = 'Tanner Collin'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx_rtd_theme',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

View File

@ -0,0 +1,20 @@
.. Spaceport documentation master file, created by
sphinx-quickstart on Tue Jan 21 06:12:17 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Spaceport's documentation!
=====================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -1,5 +1,7 @@
alabaster==0.7.12
argon2-cffi==19.2.0 argon2-cffi==19.2.0
asgiref==3.2.3 asgiref==3.2.3
Babel==2.8.0
bleach==3.1.0 bleach==3.1.0
certifi==2019.11.28 certifi==2019.11.28
cffi==1.13.2 cffi==1.13.2
@ -9,18 +11,35 @@ Django==3.0.2
django-allauth==0.41.0 django-allauth==0.41.0
django-rest-auth==0.9.5 django-rest-auth==0.9.5
djangorestframework==3.11.0 djangorestframework==3.11.0
docutils==0.16
fuzzywuzzy==0.17.0 fuzzywuzzy==0.17.0
idna==2.8 idna==2.8
imagesize==1.2.0
Jinja2==2.10.3
MarkupSafe==1.1.1
oauthlib==3.1.0 oauthlib==3.1.0
packaging==20.0
Pillow==7.0.0 Pillow==7.0.0
pkg-resources==0.0.0 pkg-resources==0.0.0
pycparser==2.19 pycparser==2.19
Pygments==2.5.2
pyparsing==2.4.6
python-dateutil==2.8.1
python-Levenshtein==0.12.0 python-Levenshtein==0.12.0
python3-openid==3.1.0 python3-openid==3.1.0
pytz==2019.3 pytz==2019.3
requests==2.22.0 requests==2.22.0
requests-oauthlib==1.3.0 requests-oauthlib==1.3.0
six==1.13.0 six==1.13.0
snowballstemmer==2.0.0
Sphinx==2.3.1
sphinx-rtd-theme==0.4.3
sphinxcontrib-applehelp==1.0.1
sphinxcontrib-devhelp==1.0.1
sphinxcontrib-htmlhelp==1.0.2
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.2
sphinxcontrib-serializinghtml==1.1.3
sqlparse==0.3.0 sqlparse==0.3.0
urllib3==1.25.7 urllib3==1.25.7
webencodings==0.5.1 webencodings==0.5.1