From caa5dcec323e1a3a29703d99b31e2092f6c84bba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bertrand=20N=C3=A9ron?= <freeh4cker@gmail.com> Date: Fri, 6 Sep 2019 17:14:44 +0200 Subject: [PATCH] :pencil2: add documentation --- Graph/doc/Makefile | 20 ++++++++++++ Graph/doc/source/algo.rst | 13 ++++++++ Graph/doc/source/conf.py | 60 ++++++++++++++++++++++++++++++++++++ Graph/doc/source/graph.rst | 15 +++++++++ Graph/doc/source/helpers.rst | 14 +++++++++ Graph/doc/source/index.rst | 26 ++++++++++++++++ 6 files changed, 148 insertions(+) create mode 100644 Graph/doc/Makefile create mode 100644 Graph/doc/source/algo.rst create mode 100644 Graph/doc/source/conf.py create mode 100644 Graph/doc/source/graph.rst create mode 100644 Graph/doc/source/helpers.rst create mode 100644 Graph/doc/source/index.rst diff --git a/Graph/doc/Makefile b/Graph/doc/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/Graph/doc/Makefile @@ -0,0 +1,20 @@ +# 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) diff --git a/Graph/doc/source/algo.rst b/Graph/doc/source/algo.rst new file mode 100644 index 0000000..855111a --- /dev/null +++ b/Graph/doc/source/algo.rst @@ -0,0 +1,13 @@ +.. 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 diff --git a/Graph/doc/source/conf.py b/Graph/doc/source/conf.py new file mode 100644 index 0000000..1ec9502 --- /dev/null +++ b/Graph/doc/source/conf.py @@ -0,0 +1,60 @@ +# 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 diff --git a/Graph/doc/source/graph.rst b/Graph/doc/source/graph.rst new file mode 100644 index 0000000..8d2e524 --- /dev/null +++ b/Graph/doc/source/graph.rst @@ -0,0 +1,15 @@ +.. 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: diff --git a/Graph/doc/source/helpers.rst b/Graph/doc/source/helpers.rst new file mode 100644 index 0000000..d3bda42 --- /dev/null +++ b/Graph/doc/source/helpers.rst @@ -0,0 +1,14 @@ +.. 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: diff --git a/Graph/doc/source/index.rst b/Graph/doc/source/index.rst new file mode 100644 index 0000000..e3665f0 --- /dev/null +++ b/Graph/doc/source/index.rst @@ -0,0 +1,26 @@ +.. 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` -- GitLab