From 72d502d0b76457b2c3bf3935eb0187ddf12c9e72 Mon Sep 17 00:00:00 2001 From: Tanner Collin Date: Tue, 21 Jan 2020 06:18:09 +0000 Subject: [PATCH] Set up boilerplate sphinx docs --- apiserver/docs/Makefile | 20 +++++++++++++ apiserver/docs/make.bat | 35 ++++++++++++++++++++++ apiserver/docs/source/conf.py | 53 +++++++++++++++++++++++++++++++++ apiserver/docs/source/index.rst | 20 +++++++++++++ apiserver/requirements.txt | 19 ++++++++++++ 5 files changed, 147 insertions(+) create mode 100644 apiserver/docs/Makefile create mode 100644 apiserver/docs/make.bat create mode 100644 apiserver/docs/source/conf.py create mode 100644 apiserver/docs/source/index.rst diff --git a/apiserver/docs/Makefile b/apiserver/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/apiserver/docs/Makefile @@ -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) diff --git a/apiserver/docs/make.bat b/apiserver/docs/make.bat new file mode 100644 index 0000000..6247f7e --- /dev/null +++ b/apiserver/docs/make.bat @@ -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 diff --git a/apiserver/docs/source/conf.py b/apiserver/docs/source/conf.py new file mode 100644 index 0000000..776278c --- /dev/null +++ b/apiserver/docs/source/conf.py @@ -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'] diff --git a/apiserver/docs/source/index.rst b/apiserver/docs/source/index.rst new file mode 100644 index 0000000..b59d711 --- /dev/null +++ b/apiserver/docs/source/index.rst @@ -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` diff --git a/apiserver/requirements.txt b/apiserver/requirements.txt index d6b3173..d55e448 100644 --- a/apiserver/requirements.txt +++ b/apiserver/requirements.txt @@ -1,5 +1,7 @@ +alabaster==0.7.12 argon2-cffi==19.2.0 asgiref==3.2.3 +Babel==2.8.0 bleach==3.1.0 certifi==2019.11.28 cffi==1.13.2 @@ -9,18 +11,35 @@ Django==3.0.2 django-allauth==0.41.0 django-rest-auth==0.9.5 djangorestframework==3.11.0 +docutils==0.16 fuzzywuzzy==0.17.0 idna==2.8 +imagesize==1.2.0 +Jinja2==2.10.3 +MarkupSafe==1.1.1 oauthlib==3.1.0 +packaging==20.0 Pillow==7.0.0 pkg-resources==0.0.0 pycparser==2.19 +Pygments==2.5.2 +pyparsing==2.4.6 +python-dateutil==2.8.1 python-Levenshtein==0.12.0 python3-openid==3.1.0 pytz==2019.3 requests==2.22.0 requests-oauthlib==1.3.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 urllib3==1.25.7 webencodings==0.5.1