Commit 418a04cd authored by Christian Rohlfing's avatar Christian Rohlfing
Browse files

Add sphinx documentation

parent c80eb9b4
# 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)
@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
Batch
*****
.. toctree::
:maxdepth: 3
.. autoprogram:: batch:_parser
:prog: batch.py
API
===
.. automodule:: batch
:members:
# 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 = 'Exam Scan'
copyright = '2021, Amrita Deb, Christian Rohlfing'
author = 'Amrita Deb, Christian Rohlfing'
# -- 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.ext.autodoc',
'sphinx.ext.coverage',
'sphinx.ext.napoleon',
]
extensions += ['sphinxcontrib.autoprogram']
# 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 = 'alabaster'
# 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']
Encrypt
*******
.. toctree::
:maxdepth: 3
.. autoprogram:: encrypt:_parser
:prog: encrypt.py
API
===
.. automodule:: encrypt
:members:
Welcome to Exam Scan's documentation!
=====================================
.. toctree::
:maxdepth: 1
:caption: Contents:
encrypt
preparemoodle
preparepdf
renamescans
supplements
watermark
batch
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Prepare Moodle
**************
.. toctree::
:maxdepth: 3
.. autoprogram:: preparemoodle:_parser
:prog: preparemoodle.py
API
===
.. automodule:: preparemoodle
:members:
Prepare PDFs
*************
.. toctree::
:maxdepth: 3
.. autoprogram:: preparepdf:_parser
:prog: preparepdf.py
API
===
.. automodule:: preparepdf
:members:
Rename Scans
************
.. toctree::
:maxdepth: 3
.. autoprogram:: renamescans:_parser
:prog: renamescans.py
API
===
.. automodule:: renamescans
:members:
sphinx>=3.5.4
sphinxcontrib-autoprogram>=0.1.7
\ No newline at end of file
Supplements
***********
.. toctree::
:maxdepth: 3
.. autoprogram:: supplements:_parser
:prog: supplements.py
API
===
.. automodule:: supplements
:members:
Watermark
*********
.. toctree::
:maxdepth: 3
.. autoprogram:: watermark:_parser
:prog: watermark.py
API
===
.. automodule:: watermark
:members:
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment