Commit caa5dcec authored by Bertrand Néron's avatar Bertrand Néron
Browse files

add documentation

parent 4d90201c
# 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)
.. MyGraph documentation master file, created by
sphinx-quickstart on Fri Sep 6 16:18:48 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. _algo:
*******************
Algorithms on graph
*******************
.. automodule:: graph.traversing
:members:
\ No newline at end of file
# 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:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- 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(os.path.join('..', '..')))
# -- Project information -----------------------------------------------------
project = 'MyGraph'
copyright = '2019, freeh4cker'
author = 'freeh4cker'
# The full version, including alpha/beta/rc tags
release = '1.0'
# -- General configuration ---------------------------------------------------
# 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_autodoc_typehints',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
]
# 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 = []
# -- 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'
html_theme = 'classic'
# 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']
\ No newline at end of file
.. MyGraph documentation master file, created by
sphinx-quickstart on Fri Sep 6 16:18:48 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. _graph:
********************
Graph data structure
********************
.. automodule:: graph.graph_3
:members:
:private-members:
:special-members:
.. MyGraph documentation master file, created by
sphinx-quickstart on Fri Sep 6 16:18:48 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. _helpers:
************************************************
data structure used by graph or graph algorithms
************************************************
.. automodule:: graph.helpers
:members:
:private-members:
.. MyGraph documentation master file, created by
sphinx-quickstart on Fri Sep 6 16:18:48 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to MyGraph's documentation!
===================================
Graph API reference
===================
.. toctree::
:maxdepth: 2
:caption: Contents:
graph
algo
helpers
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