Commit 8cba444c authored by Markus Lindelöw's avatar Markus Lindelöw
Browse files

Add sphinx

parent 32f2d513
Loading
Loading
Loading
Loading

.gitlab-ci.yml

0 → 100644
+12 −0
Changes for .gitlab-ci.yml: 12 added lines, 0 removed lines.
Original line number Diff line number Diff line
variables:
    LC_ALL: C.UTF-8
    LANG: C.UTF-8

Sphinx:
  image: alpine:3.9
  script:
    - apk add python3 make doxygen
    - pip3 install sphinx
    - pip3 install -r docs/requirements.txt
    - cd docs
    - make html

docs/Doxyfile

0 → 100644
+2511 −0

File added.

Preview size limit exceeded, changes collapsed.

docs/Makefile

0 → 100644
+20 −0
Changes for docs/Makefile: 20 added lines, 0 removed lines.
Original line number Diff line number Diff line
# 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     = .
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)

docs/conf.py

0 → 100644
+66 −0
Changes for docs/conf.py: 66 added lines, 0 removed lines.
Original line number Diff line number Diff line
# 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:
# 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('.'))
from subprocess import call

# -- Project information -----------------------------------------------------

project = u'TinyFiber'
copyright = u'2020, Markus Lindelöw'
author = u'Markus Lindelöw'


# -- General configuration ---------------------------------------------------

master_doc = 'index'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'breathe'
]

# 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 = ['_build', 'Thumbs.db', '.DS_Store']


# -- Breathe config ---

breathe_projects = {'TinyFiber': '_doxyxml/'}
breathe_default_project = 'TinyFiber'



# -- 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 = 'default'

# 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']


# -- Generate doxygen xml ------
call('doxygen')

docs/index.rst

0 → 100644
+21 −0
Changes for docs/index.rst: 21 added lines, 0 removed lines.
Original line number Diff line number Diff line
Welcome to TinyFiber's documentation!
========================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:



Indices and tables
==================

* :ref:`genindex`



Reference documentation
=======================

.. doxygenindex::
Loading