From 021243df794c20f229c50b61f7ea201f334c344d Mon Sep 17 00:00:00 2001 From: Otavio Napoli Date: Mon, 29 Jan 2024 19:51:36 -0300 Subject: [PATCH] Addec docs --- .github/workflows/docs.yml | 36 +++++++++++++ docs/Makefile | 20 ++++++++ docs/api.rst | 8 +++ docs/conf.py | 101 +++++++++++++++++++++++++++++++++++++ docs/index.rst | 22 ++++++++ docs/installation.rst | 2 + docs/make.bat | 35 +++++++++++++ pyproject.toml | 4 ++ 8 files changed, 228 insertions(+) create mode 100644 .github/workflows/docs.yml create mode 100644 docs/Makefile create mode 100644 docs/api.rst create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/installation.rst create mode 100644 docs/make.bat diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..777625f --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,36 @@ +name: ssl_tools +on: + push: + branches: + - main + +jobs: + docs: + name: SSL tools documentation + runs-on: ubuntu-latest + steps: + + - uses: actions/checkout@v2 + + - name: Install Python + uses: actions/setup-python@v1 + with: + python-version: 3.10 + + - name: Install requirements + run: | + pip3 install sphinx sphinx-rtd-theme sphinx-autodoc-typehints sphinx-argparse sphinx-autoapi nbsphinx pandoc + + - name: Build docs + run: | + cd docs + make html + + # https://github.com/peaceiris/actions-gh-pages + - name: Deploy + if: success() + uses: peaceiris/actions-gh-pages@v3 + with: + publish_branch: gh-pages + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: docs/_build/html/ \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/docs/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 = . +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/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..a7d46f4 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,8 @@ +Programming Reference +----------------------- + +Here is the Programming Interface + +.. toctree:: + + autoapi/ssl_tools/index diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..bf29428 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,101 @@ +# 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 +import sys +import os +sys.path.insert(0, os.path.abspath('../')) + +import sphinx_rtd_theme + +# -- 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 = 'SSLTools' +copyright = '2024, H.IAAC' +author = 'H.IAAC' + +source_suffix = ['.rst'] +master_doc = 'index' + +# 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 = [ + '**.ipynb_checkpoints', + "**ipynb_checkpoints" +] + + +# -- 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', + 'autoapi.extension', + 'sphinx_rtd_theme', + 'sphinx.ext.viewcode', + 'sphinx.ext.autodoc.typehints', + 'sphinx.ext.mathjax', + "nbsphinx", + "IPython.sphinxext.ipython_console_highlighting" +] + +# 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 = ['_build', 'Thumbs.db', '.DS_Store'] + +####### Auto API +autoapi_type = 'python' +autoapi_dirs = ['../ssl_tools/'] +autoapi_member_order = 'alphabetical' +autoapi_python_use_implicit_namespaces = True +autoapi_python_class_content = 'both' +autoapi_file_patterns = ['*.py'] +autoapi_generate_api_docs = True +autoapi_add_toctree_entry = False +# source_suffix = '.rst' +autodoc_typehints = 'description' + +######## NBSPHINX +nbsphinx_execute = 'never' +nbsphinx_allow_errors = True +nbsphinx_codecell_lexer = 'python3' +nbsphinx_execute_arguments = [ + "--InlineBackend.figure_formats={'svg', 'pdf'}", + "--InlineBackend.rc={'figure.dpi': 96}", +] + + + +# -- 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 = 'sphinx_rtd_theme' +htmlhelp_basename = 'ssl_tools_docs' +htmlhelp_basename = 'ssl_tools_docs' +source_encoding = 'utf-8' + +# 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/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..403e525 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,22 @@ +.. SSLTools documentation master file, created by + sphinx-quickstart on Mon Jan 29 18:33:36 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to SSLTools's documentation! +==================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + installation + api + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 0000000..66a4455 --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,2 @@ +Installation +----------------- \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..153be5e --- /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.https://www.sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/pyproject.toml b/pyproject.toml index 9f98957..787cc53 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -35,8 +35,12 @@ dependencies = [ [project.optional-dependencies] dev = ["mock", "pytest", "black", "isort"] +docs = ["sphinx", "sphinx-rtd-theme", "sphinx-autodoc-typehints", "sphinx-argparse", "sphinx", "sphinx-autoapi", "nbsphinx", "pandoc", "Ipython"] [project.urls] "Bug Tracker" = "https://github.com/otavioon/ssl_tools/issues" "Homepage" = "https://github.com/otavioon/ssl_tools" + +[tool.setuptools] +py-modules = ["ssl_tools"] \ No newline at end of file