Skip to content
Snippets Groups Projects
Commit d2c776c9 authored by GANGLOFF Hugo's avatar GANGLOFF Hugo 🤠
Browse files

Merge branch 'documentation' into 'main'

Documentation

See merge request hugo.gangloff/xpcax!3
parents 1d9b2b7c e1032a90
No related branches found
No related tags found
1 merge request!3Documentation
Pipeline #94390 passed with stages
in 1 minute and 48 seconds
__pycache__/
build/
xpcax.egg-info/
doc/build/
......@@ -39,3 +39,29 @@ publish_package:
- docker
only:
- tags
build_doc:
stage: build
before_script:
- pip install sphinx sphinx_rtd_theme
script:
- pip install .
- make -C doc html
artifacts:
untracked: true
expire_in: 1 week
tags:
- docker
pages:
stage: publish
script:
- rm -rf public/
- cp -r doc/build/html public/
artifacts:
paths:
- public
tags:
- docker
only:
- tags
# 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)
# pylint: skip-file
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = "xpcax" # necesarily the package name
copyright = "2023, INRAE, Hugo Gangloff"
author = "Hugo Gangloff"
from importlib.metadata import version
release = version(project)
version = release
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
"sphinx.ext.napoleon",
"sphinx_rtd_theme",
]
templates_path = ["_templates"]
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]
.. xpcax documentation master file, created by
sphinx-quickstart on Thu Apr 27 16:28:09 2023.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to xpcax's documentation!
=================================
.. toctree::
:maxdepth: 1
:caption: Contents:
./module.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Module documentation
====================
.. automodule:: xpcax
:members:
:imported-members:
:inherited-members:
:special-members: __init__
:undoc-members:
:show-inheritance:
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment