Spaces:
Runtime error
Runtime error
added sphinx docs template
Browse files- docs/Makefile +20 -0
- docs/make.bat +35 -0
- docs/source/conf.py +58 -0
- docs/source/index.rst +20 -0
docs/Makefile
ADDED
@@ -0,0 +1,20 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# Minimal makefile for Sphinx documentation
|
2 |
+
#
|
3 |
+
|
4 |
+
# You can set these variables from the command line, and also
|
5 |
+
# from the environment for the first two.
|
6 |
+
SPHINXOPTS ?=
|
7 |
+
SPHINXBUILD ?= sphinx-build
|
8 |
+
SOURCEDIR = source
|
9 |
+
BUILDDIR = build
|
10 |
+
|
11 |
+
# Put it first so that "make" without argument is like "make help".
|
12 |
+
help:
|
13 |
+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
14 |
+
|
15 |
+
.PHONY: help Makefile
|
16 |
+
|
17 |
+
# Catch-all target: route all unknown targets to Sphinx using the new
|
18 |
+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
19 |
+
%: Makefile
|
20 |
+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
docs/make.bat
ADDED
@@ -0,0 +1,35 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
@ECHO OFF
|
2 |
+
|
3 |
+
pushd %~dp0
|
4 |
+
|
5 |
+
REM Command file for Sphinx documentation
|
6 |
+
|
7 |
+
if "%SPHINXBUILD%" == "" (
|
8 |
+
set SPHINXBUILD=sphinx-build
|
9 |
+
)
|
10 |
+
set SOURCEDIR=source
|
11 |
+
set BUILDDIR=build
|
12 |
+
|
13 |
+
if "%1" == "" goto help
|
14 |
+
|
15 |
+
%SPHINXBUILD% >NUL 2>NUL
|
16 |
+
if errorlevel 9009 (
|
17 |
+
echo.
|
18 |
+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
19 |
+
echo.installed, then set the SPHINXBUILD environment variable to point
|
20 |
+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
21 |
+
echo.may add the Sphinx directory to PATH.
|
22 |
+
echo.
|
23 |
+
echo.If you don't have Sphinx installed, grab it from
|
24 |
+
echo.https://www.sphinx-doc.org/
|
25 |
+
exit /b 1
|
26 |
+
)
|
27 |
+
|
28 |
+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
29 |
+
goto end
|
30 |
+
|
31 |
+
:help
|
32 |
+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
33 |
+
|
34 |
+
:end
|
35 |
+
popd
|
docs/source/conf.py
ADDED
@@ -0,0 +1,58 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# Configuration file for the Sphinx documentation builder.
|
2 |
+
#
|
3 |
+
# This file only contains a selection of the most common options. For a full
|
4 |
+
# list see the documentation:
|
5 |
+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
6 |
+
|
7 |
+
# -- Path setup --------------------------------------------------------------
|
8 |
+
|
9 |
+
# If extensions (or modules to document with autodoc) are in another directory,
|
10 |
+
# add these directories to sys.path here. If the directory is relative to the
|
11 |
+
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
12 |
+
#
|
13 |
+
# import os
|
14 |
+
# import sys
|
15 |
+
# sys.path.insert(0, os.path.abspath('.'))
|
16 |
+
|
17 |
+
|
18 |
+
# -- Project information -----------------------------------------------------
|
19 |
+
|
20 |
+
project = 'politweet'
|
21 |
+
copyright = '2022, Oresti Theodoridis, Marcus Ascard, Mosa Hosseini, Nils Ekstrand'
|
22 |
+
author = 'Oresti Theodoridis, Marcus Ascard, Mosa Hosseini, Nils Ekstrand'
|
23 |
+
|
24 |
+
# The full version, including alpha/beta/rc tags
|
25 |
+
release = '0.1.0'
|
26 |
+
|
27 |
+
|
28 |
+
# -- General configuration ---------------------------------------------------
|
29 |
+
|
30 |
+
# Add any Sphinx extension module names here, as strings. They can be
|
31 |
+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
32 |
+
# ones.
|
33 |
+
extensions = [
|
34 |
+
'sphinx.ext.duration',
|
35 |
+
'sphinx.ext.doctest',
|
36 |
+
'sphinx.ext.autodoc',
|
37 |
+
]
|
38 |
+
|
39 |
+
# Add any paths that contain templates here, relative to this directory.
|
40 |
+
templates_path = ['_templates']
|
41 |
+
|
42 |
+
# List of patterns, relative to source directory, that match files and
|
43 |
+
# directories to ignore when looking for source files.
|
44 |
+
# This pattern also affects html_static_path and html_extra_path.
|
45 |
+
exclude_patterns = []
|
46 |
+
|
47 |
+
|
48 |
+
# -- Options for HTML output -------------------------------------------------
|
49 |
+
|
50 |
+
# The theme to use for HTML and HTML Help pages. See the documentation for
|
51 |
+
# a list of builtin themes.
|
52 |
+
#
|
53 |
+
html_theme = 'alabaster'
|
54 |
+
|
55 |
+
# Add any paths that contain custom static files (such as style sheets) here,
|
56 |
+
# relative to this directory. They are copied after the builtin static files,
|
57 |
+
# so a file named "default.css" will overwrite the builtin "default.css".
|
58 |
+
html_static_path = ['_static']
|
docs/source/index.rst
ADDED
@@ -0,0 +1,20 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
.. politweet documentation master file, created by
|
2 |
+
sphinx-quickstart on Mon Jul 18 11:41:38 2022.
|
3 |
+
You can adapt this file completely to your liking, but it should at least
|
4 |
+
contain the root `toctree` directive.
|
5 |
+
|
6 |
+
Welcome to politweet's documentation!
|
7 |
+
=====================================
|
8 |
+
|
9 |
+
.. toctree::
|
10 |
+
:maxdepth: 2
|
11 |
+
:caption: Contents:
|
12 |
+
|
13 |
+
|
14 |
+
|
15 |
+
Indices and tables
|
16 |
+
==================
|
17 |
+
|
18 |
+
* :ref:`genindex`
|
19 |
+
* :ref:`modindex`
|
20 |
+
* :ref:`search`
|