Fork and adapt sphinx-skeleton

parents
Pipeline #42564895 passed with stages
in 58 seconds
docs/build/*
image: alpine
pages:
script:
- apk --no-cache add py3-pip python3-dev
- pip3 install sphinx
- apk --no-cache add make
- make -C $DOCSPATH html
- mv $DOCSPATH/build/html public/
artifacts:
paths:
- public
only:
refs:
- tags
variables:
DOCSPATH: ./
Copyright 2019 Konstantinos Demartinos
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = source
BUILDDIR = build
# Configure the generation of apidocs
SPHINXAPIDOC = sphinx-apidoc
SPHINXAPIOPTS =
MODPATH =
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
# Configure gitlab-ci on the project
gitlab-ci:
mv .gitlab-ci.yml ../
# Rule to construct API docs
apidoc:
@$(SPHINXAPIDOC) $(SPHINXAPIOPTS) -eTM -o \
"$(SOURCEDIR)/_modules" $(MODPATH)
clean-repo:
rm -rf .git
find ./ -maxdepth 2 -type f -name '.*' -and ! -name '.gitlab*' \
-exec rm -f {} +
test-clean-repo:
find ../ -maxdepth 2 -type f -name '.*' -and ! -name '.gitlab*'
.PHONY: help Makefile apidoc clean-repo test-clean-repo
# 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)
dx-docs-template
===============
A template configuration for generating sphinx docs for dx projects
-------------------------------------------------------------------
Features
^^^^^^^^
* Separate ``source`` and ``build`` directories.
* Expanded ``Makefile`` that generates automatically API docs
based on local packages.
Using the template
------------------
#. Copy the template into your project::
$ git clone <this-repo> path/to/docs/
$ make -C path/to/docs/ clean-repo
#. Configure CI for your gitlab project [optional]::
$ make -C path/to/docs/ gitlab-ci
This essentially moves the required ``.gitlab-ci.yml`` to the
root level of your repository. Alternatively, you can explicitly
define the path to ``.gitlab-ci.yml`` in your project settings.
Don't forget to override ``DOCSPATH`` in ``.gitlab-ci.yml``
by assigning the value ``path/to/docs/``.
By default CI is configured to run only when a tag is created.
#. Set configuration options in ``path/to/docs/source/conf.py``.
#. Add content in ``path/to/docs/source/chapters/``.
#. Modify ``path/to/docs/source/index.rst`` accordingly.
#. Create API docs for your package::
$ make MODPATH=path/to/package -C path/to/docs/ apidoc
#. Build documentation::
$ make -C path/to/docs/ html
.. hint::
Of course, the last two commands can be combined as follows::
$ make -C path/to/docs/ MODPATH=path/to/package apidoc html
Precedence of ``apidoc`` over the ``html`` rule is important though.
License
-------
This template is published under the `MIT LICENSE <LICENSE>`_.
Credits
-------
* The default theme is `Alabaster <https://github.com/bitprophet/alabaster>`_.
* The skeleton is based on an automatically generated structure of files
through ``sphinx-quickstart``. See `Sphinx docs <http://www.sphinx-doc.org>`_
for more details.
********
API docs
********
.. note::
Modify this `source`_ file with the following content::
..include:: <package.rst>
where ``<package.rst>`` is generated through::
$ make MODPATH=path/to/package apidoc
.. _source: ../_sources/_modules/modules.rst.txt
.. ..include:: <package>.rst
Using the template
==================
#. Copy the template into your project::
$ git clone <this-repo> path/to/docs/
$ make -C path/to/docs/ clean-repo
#. Configure CI for your gitlab project::
$ make -C path/to/docs/ gitlab-ci
This essentially moves the required ``.gitlab-ci.yml`` to the
root level of your repository. Alternatively, you can explicitly
define the path to ``.gitlab-ci.yml`` in your project settings.
.. important::
Don't forget to ovveride the ``DOCSPATH`` variable in ``.gitlab-ci.yml``
with the actual path of your project's docs. E.g. ``path/to/docs``.
By default CI runs when a tag is created and published.
#. Set configuration options in ``path/to/docs/source/conf.py``.
#. Add content in ``path/to/docs/source/chapters/``.
#. Modify ``path/to/docs/source/index.rst`` accordingly.
#. Create API docs for your package::
$ make MODPATH=path/to/package -C path/to/docs/ apidoc
#. Build documentation::
$ make -C path/to/docs/ html
.. hint::
Of course, the last two commands can be combined as follows::
$ make -C path/to/docs/ MODPATH=path/to/package apidoc html
Precedence of ``apidoc`` over the ``html`` rule is important though.
# -*- 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
# The following assume a structure
#
# project/
# src/
# docs/
# source/
# conf.py
#
# so that it adds the source-code to python path.
#
# Override if necessary!
rel_src_path_level = '../..'
sys.path.insert(0, os.path.abspath(rel_src_path_level))
# -- Project information -----------------------------------------------------
project = 'dx-docs-template'
copyright = 'demetriou engineering ltd.'
author = 'Konstantinos Demartinos'
#
# # 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.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'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 = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None
# -- 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.
#
# TODO: Populate theme options [optional]
html_theme_options = {
'description': ("Template configuration for generating Sphinx "
"docs for dx projects"),
# 'fixed_sidebar': True,
'logo': 'logo.png',
# 'logo_name': True,
'show_related': True,
}
show_copyright = False
# 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 = 'dx-punchdoc'
# -- Options for LaTeX output ------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, f'{project}.tex', f'{project} Documentation',
author, 'manual'),
]
# -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, f'{project}.tex', f'{project} Documentation',
[author], 1)
]
# -- Options for Texinfo output ----------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, project, f'{project} Documentation',
author, project, 'One line description of project.',
'Miscellaneous'),
]
# -- Options for Epub output -------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = project
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''
# A unique identification for the text.
#
# epub_uid = ''
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Extension configuration -------------------------------------------------
# -- Options for intersphinx extension ---------------------------------------
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
'https://docs.python.org/': None,
'https://docs.scipy.org/doc/numpy/': None,
}
# -- Options for todo extension ----------------------------------------------
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
.. dx-punch documentation master file, created by
sphinx-quickstart on Tue Dec 18 10:46:56 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to demo documentation for `dx` projects with Sphinx!
============================================================
A template configuration for generating sphinx docs
---------------------------------------------------
Features
^^^^^^^^
* Separate ``source`` and ``build`` directories.
* Expanded ``Makefile`` that generates automatically API docs
based on local packages.
Usage
-----
.. toctree::
chapters/usage
.. toctree::
:hidden:
:glob:
_modules/modules
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