From 4a8fbfe149fa086b51cb7eb6ef5828340eefbd4d Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Fri, 23 Jul 2021 22:47:45 +0200 Subject: [PATCH 1/3] Run sphinx-quickstart --- docs/Makefile | 19 +++++ docs/conf.py | 186 +++++++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 20 ++++++ docs/make.bat | 35 ++++++++++ 4 files changed, 260 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/make.bat diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..298ea9e --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +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) \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..18e2974 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,186 @@ +# -*- 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 +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'PySecretHandshake' +copyright = '2021, PySecretHandshake contributors (see AUTHORS for more details)' +author = 'PySecretHandshake contributors (see AUTHORS for more details)' + +# The short X.Y version +version = '' +# The full version, including alpha/beta/rc tags +release = '0.1.0.dev4' + + +# -- 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.coverage', + '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 = ['_build', 'Thumbs.db', '.DS_Store'] + +# 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. +# +# html_theme_options = {} + +# 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 = 'PySecretHandshakedoc' + + +# -- 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, 'PySecretHandshake.tex', 'PySecretHandshake Documentation', + 'PySecretHandshake contributors (see AUTHORS for more details)', '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, 'pysecrethandshake', 'PySecretHandshake 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, 'PySecretHandshake', 'PySecretHandshake Documentation', + author, 'PySecretHandshake', '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} diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..0fecb0e --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +.. PySecretHandshake documentation master file, created by + sphinx-quickstart on Fri Jul 23 22:47:25 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to PySecretHandshake's documentation! +============================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..27f573b --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd From a000ddac69541dc3254f96ccd4f1190c24c5a81f Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Fri, 23 Jul 2021 22:56:04 +0200 Subject: [PATCH 2/3] Add autodoc --- docs/.gitignore | 1 + docs/conf.py | 7 +++++++ docs/index.rst | 2 ++ docs/reference/boxstream.rst | 5 +++++ docs/reference/crypto.rst | 5 +++++ docs/reference/index.rst | 9 +++++++++ docs/reference/network.rst | 5 +++++ docs/reference/util.rst | 4 ++++ 8 files changed, 38 insertions(+) create mode 100644 docs/.gitignore create mode 100644 docs/reference/boxstream.rst create mode 100644 docs/reference/crypto.rst create mode 100644 docs/reference/index.rst create mode 100644 docs/reference/network.rst create mode 100644 docs/reference/util.rst diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..e35d885 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +_build diff --git a/docs/conf.py b/docs/conf.py index 18e2974..1f57f6a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -180,6 +180,13 @@ # -- Extension configuration ------------------------------------------------- +# -- Options for autodoc extension ------------------------------------------- + +autodoc_default_options = { + 'members': True, + 'undoc-members': True +} + # -- Options for intersphinx extension --------------------------------------- # Example configuration for intersphinx: refer to the Python standard library. diff --git a/docs/index.rst b/docs/index.rst index 0fecb0e..99da09c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,6 +10,8 @@ Welcome to PySecretHandshake's documentation! :maxdepth: 2 :caption: Contents: + reference/index + Indices and tables diff --git a/docs/reference/boxstream.rst b/docs/reference/boxstream.rst new file mode 100644 index 0000000..ce7d0d8 --- /dev/null +++ b/docs/reference/boxstream.rst @@ -0,0 +1,5 @@ +secret_handshake.boxstream +========================== + +.. automodule:: secret_handshake.boxstream + :undoc-members: diff --git a/docs/reference/crypto.rst b/docs/reference/crypto.rst new file mode 100644 index 0000000..182306d --- /dev/null +++ b/docs/reference/crypto.rst @@ -0,0 +1,5 @@ +secret_handshake.crypto +======================= + +.. automodule:: secret_handshake.crypto + diff --git a/docs/reference/index.rst b/docs/reference/index.rst new file mode 100644 index 0000000..7a4cf49 --- /dev/null +++ b/docs/reference/index.rst @@ -0,0 +1,9 @@ +Reference +========= + +.. toctree:: + + boxstream + crypto + network + util diff --git a/docs/reference/network.rst b/docs/reference/network.rst new file mode 100644 index 0000000..67e083d --- /dev/null +++ b/docs/reference/network.rst @@ -0,0 +1,5 @@ +secret_handshake.network +======================== + +.. automodule:: secret_handshake.network + diff --git a/docs/reference/util.rst b/docs/reference/util.rst new file mode 100644 index 0000000..af9a8f7 --- /dev/null +++ b/docs/reference/util.rst @@ -0,0 +1,4 @@ +secret_handshake.util +===================== + +.. automodule:: secret_handshake.util From ac56b4cb56d98b7bd8872cbc91630b37ae3d78dc Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Fri, 23 Jul 2021 23:02:44 +0200 Subject: [PATCH 3/3] Run documentation build on Travis. --- .travis.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index bdd531a..bb86a49 100644 --- a/.travis.yml +++ b/.travis.yml @@ -8,6 +8,8 @@ python: install: - pip install .[tests] - pip install coveralls -script: pytest +script: + - pytest + - make -C docs html after_success: - coveralls