Commit f0d64de8 authored by Barkin Simsek's avatar Barkin Simsek 🐢
Browse files

Add sphinx configuration (#74)

parent 2870e19a
......@@ -147,4 +147,7 @@ report.xml
.vscode/
.captchamonitor-db-data/
\ No newline at end of file
.captchamonitor-db-data/
public
_build
\ No newline at end of file
......@@ -18,4 +18,15 @@ tests:
artifacts:
reports:
cobertura: coverage.xml
junit: report.xml
\ No newline at end of file
junit: report.xml
pages:
stage: deploy
script:
- pip install -U sphinx
- sphinx-build -b html ./docs/sphinx/ public
artifacts:
paths:
- public
only:
- master
\ No newline at end of file
......@@ -28,11 +28,11 @@ logs:
docker-compose logs --tail=100 captchamonitor cm-worker
init: check_root
apt install python3-pip
pip3 install darglint black mypy pylint isort sphinx
apt install python3-pip mypy
pip3 install darglint black pylint isort sphinx
docs:
sphinx-build -b html . public
docs: FORCE
sphinx-build -b html ./docs/sphinx/ public
check: check_non_root
@echo "\n\e[93m>> Installing requirements\e[0m"
......@@ -59,4 +59,6 @@ check_root:
ifneq ($(shell id -u), 0)
@echo "\n>> Please run this command with sudo"
exit 1
endif
\ No newline at end of file
endif
FORCE: ;
\ No newline at end of file
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = .
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)
\ No newline at end of file
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config
# -- 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("../../src/captchamonitor/"))
# -- Project information -----------------------------------------------------
project = "CAPTCHA Monitor"
copyright = "2021, Barkin Simsek"
author = "Barkin Simsek"
# The short X.Y version
version = "1.0"
# The full version, including alpha/beta/rc tags
release = "1.0.0"
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# 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.doctest",
"sphinx.ext.todo",
"sphinx.ext.coverage",
"sphinx.ext.mathjax",
"sphinx.ext.viewcode",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ".rst"
# The master toctree document.
master_doc = "index"
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# 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 = ["_build", "Thumbs.db", ".DS_Store"]
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"
# -- 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"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
# 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"]
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = "CAPTCHAMonitordoc"
# -- Options for todo extension ----------------------------------------------
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
.. CAPTCHA Monitor documentation master file, created by
sphinx-quickstart on Fri Jun 4 07:51:22 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to CAPTCHA Monitor's documentation!
===========================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
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