[skip ci] Refresh docs

.readthedocs.yml

@@ -1,8 +1,11 @@
 version: 2
 sphinx:
   configuration: docs/conf.py
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
 python:
-  version: 3.8
   install:
     - requirements: docs/requirements.txt
     - method: pip

docs/Makefile

@@ -1,10 +1,10 @@
 # Minimal makefile for Sphinx documentation
 #
 
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = msoffcrypto-tool
+# 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
 
@@ -17,4 +17,4 @@ help:
 # 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)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -1,164 +1,59 @@
-# -*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('../'))
-
+# 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 = 'msoffcrypto-tool'
-copyright = '2015, nolze'
-author = 'nolze'
-
-# The short X.Y version
-version = ''
-# The full version, including alpha/beta/rc tags
-release = ''
+project = "msoffcrypto-tool"
+copyright = "nolze"
+author = "nolze"
 
+version = ""
+release = version
 
 # -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = '1.0'
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../"))
 
-# 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',
-    'sphinxcontrib.autoprogram',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinxcontrib.autoprogram",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "myst_parser",
 ]
 
-napoleon_numpy_docstring = False
-
-# 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 = 'sphinx'
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- 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'
-
-# 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 = 'msoffcrypto-tooldoc'
-
-
-# -- 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',
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "furo"
+html_static_path = ["_static"]
+
+# html_title = "<project> <version>"
+html_title = "msoffcrypto-tool"
+html_theme_options = {
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/nolze/msoffcrypto-tool",
+            "html": """
+                <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
+                    <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
+                </svg>
+            """,
+            "class": "",
+        },
+    ],
 }
 
-# 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, 'msoffcrypto-tool.tex', 'msoffcrypto-tool Documentation',
-     'nolze', '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, 'msoffcrypto-tool', 'msoffcrypto-tool 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, 'msoffcrypto-tool', 'msoffcrypto-tool Documentation',
-     author, 'msoffcrypto-tool', 'One line description of project.',
-     'Miscellaneous'),
-]
-
-
-# -- Extension configuration -------------------------------------------------
+myst_enable_extensions = ["tasklist"]

docs/index.rst

@@ -1,21 +1,23 @@
 .. msoffcrypto-tool documentation master file, created by
-   sphinx-quickstart on Sun May 13 00:50:02 2018.
+   sphinx-quickstart on Tue Oct 17 02:16:54 2023.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
 msoffcrypto-tool
-============================================
+================
+
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
+   :start-after: msoffcrypto-tool
 
 .. toctree::
+   :hidden:
    :maxdepth: 2
    :caption: Contents:
-    
+
    cli
    msoffcrypto
 
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+.. * :ref:`genindex`
+.. * :ref:`modindex`
+.. * :ref:`search`

docs/make.bat

@@ -9,9 +9,6 @@ if "%SPHINXBUILD%" == "" (
 )
 set SOURCEDIR=.
 set BUILDDIR=_build
-set SPHINXPROJ=msoffcrypto-tool
-
-if "%1" == "" goto help
 
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
@@ -22,15 +19,17 @@ if errorlevel 9009 (
 	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/
+	echo.https://www.sphinx-doc.org/
 	exit /b 1
 )
 
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 
 :help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 
 :end
 popd

docs/modules.rst

@@ -2,6 +2,6 @@ msoffcrypto
 ===========
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 1
 
    msoffcrypto

docs/msoffcrypto.exceptions.rst

@@ -0,0 +1,10 @@
+msoffcrypto.exceptions package
+==============================
+
+Module contents
+---------------
+
+.. automodule:: msoffcrypto.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/msoffcrypto.rst

@@ -5,22 +5,12 @@ Subpackages
 -----------
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 1
 
+   msoffcrypto.exceptions
    msoffcrypto.format
    msoffcrypto.method
 
-Submodules
-----------
-
-msoffcrypto.exceptions module
------------------------------
-
-.. automodule:: msoffcrypto.exceptions
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 Module contents
 ---------------
 

docs/requirements.txt

@@ -1,2 +1,43 @@
-sphinxcontrib-autoprogram
-
+alabaster==0.7.13 ; python_version >= "3.8" and python_version < "4.0"
+babel==2.13.0 ; python_version >= "3.8" and python_version < "4.0"
+beautifulsoup4==4.12.2 ; python_version >= "3.8" and python_version < "4.0"
+certifi==2023.7.22 ; python_version >= "3.8" and python_version < "4.0"
+cffi==1.15.1 ; python_version >= "3.8" and python_version < "4.0"
+charset-normalizer==3.3.0 ; python_version >= "3.8" and python_version < "4.0"
+colorama==0.4.6 ; python_version >= "3.8" and python_version < "4.0"
+cryptography==41.0.3 ; python_version >= "3.8" and python_version < "4.0"
+docutils==0.20.1 ; python_version >= "3.8" and python_version < "4.0"
+furo==2023.9.10 ; python_version >= "3.8" and python_version < "4.0"
+idna==3.4 ; python_version >= "3.8" and python_version < "4.0"
+imagesize==1.4.1 ; python_version >= "3.8" and python_version < "4.0"
+importlib-metadata==6.8.0 ; python_version >= "3.8" and python_version < "3.10"
+jinja2==3.1.2 ; python_version >= "3.8" and python_version < "4.0"
+livereload==2.6.3 ; python_version >= "3.8" and python_version < "4.0"
+markdown-it-py==3.0.0 ; python_version >= "3.8" and python_version < "4.0"
+markupsafe==2.1.3 ; python_version >= "3.8" and python_version < "4.0"
+mdit-py-plugins==0.4.0 ; python_version >= "3.8" and python_version < "4.0"
+mdurl==0.1.2 ; python_version >= "3.8" and python_version < "4.0"
+myst-parser==2.0.0 ; python_version >= "3.8" and python_version < "4.0"
+olefile==0.46 ; python_version >= "3.8" and python_version < "4.0"
+packaging==23.1 ; python_version >= "3.8" and python_version < "4.0"
+pycparser==2.21 ; python_version >= "3.8" and python_version < "4.0"
+pygments==2.16.1 ; python_version >= "3.8" and python_version < "4.0"
+pytz==2023.3.post1 ; python_version >= "3.8" and python_version < "3.9"
+pyyaml==6.0.1 ; python_version >= "3.8" and python_version < "4.0"
+requests==2.31.0 ; python_version >= "3.8" and python_version < "4.0"
+six==1.16.0 ; python_version >= "3.8" and python_version < "4.0"
+snowballstemmer==2.2.0 ; python_version >= "3.8" and python_version < "4.0"
+soupsieve==2.5 ; python_version >= "3.8" and python_version < "4.0"
+sphinx-autobuild==2021.3.14 ; python_version >= "3.8" and python_version < "4.0"
+sphinx-basic-ng==1.0.0b2 ; python_version >= "3.8" and python_version < "4.0"
+sphinx==7.1.2 ; python_version >= "3.8" and python_version < "4.0"
+sphinxcontrib-applehelp==1.0.4 ; python_version >= "3.8" and python_version < "4.0"
+sphinxcontrib-autoprogram==0.1.8 ; python_version >= "3.8" and python_version < "4.0"
+sphinxcontrib-devhelp==1.0.2 ; python_version >= "3.8" and python_version < "4.0"
+sphinxcontrib-htmlhelp==2.0.1 ; python_version >= "3.8" and python_version < "4.0"
+sphinxcontrib-jsmath==1.0.1 ; python_version >= "3.8" and python_version < "4.0"
+sphinxcontrib-qthelp==1.0.3 ; python_version >= "3.8" and python_version < "4.0"
+sphinxcontrib-serializinghtml==1.1.5 ; python_version >= "3.8" and python_version < "4.0"
+tornado==6.3.3 ; python_version >= "3.8" and python_version < "4.0"
+urllib3==2.0.6 ; python_version >= "3.8" and python_version < "4.0"
+zipp==3.17.0 ; python_version >= "3.8" and python_version < "3.10"