mirror of
https://github.com/Eledio/superfaktura-client.git
synced 2025-11-01 00:18:25 +01:00
sphinx: add autogenerated documentation
This commit is contained in:
20
docs/Makefile
Normal file
20
docs/Makefile
Normal file
@@ -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)
|
||||||
35
docs/make.bat
Normal file
35
docs/make.bat
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
@ECHO OFF
|
||||||
|
|
||||||
|
pushd %~dp0
|
||||||
|
|
||||||
|
REM Command file for Sphinx documentation
|
||||||
|
|
||||||
|
if "%SPHINXBUILD%" == "" (
|
||||||
|
set SPHINXBUILD=sphinx-build
|
||||||
|
)
|
||||||
|
set SOURCEDIR=source
|
||||||
|
set BUILDDIR=build
|
||||||
|
|
||||||
|
%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
|
||||||
|
)
|
||||||
|
|
||||||
|
if "%1" == "" goto help
|
||||||
|
|
||||||
|
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||||
|
goto end
|
||||||
|
|
||||||
|
:help
|
||||||
|
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||||
|
|
||||||
|
:end
|
||||||
|
popd
|
||||||
34
docs/source/conf.py
Normal file
34
docs/source/conf.py
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
# Configuration file for the Sphinx documentation builder.
|
||||||
|
#
|
||||||
|
# For the full list of built-in configuration values, see the documentation:
|
||||||
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
sys.path.insert(0, os.path.abspath('../..'))
|
||||||
|
|
||||||
|
# -- Project information -----------------------------------------------------
|
||||||
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||||||
|
|
||||||
|
project = 'SuperFaktura API client'
|
||||||
|
copyright = '2025, Richard Kubíček, Eledio s.r.o.'
|
||||||
|
author = 'Richard Kubíček'
|
||||||
|
|
||||||
|
# -- General configuration ---------------------------------------------------
|
||||||
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||||
|
|
||||||
|
extensions = [
|
||||||
|
'sphinx.ext.autodoc',
|
||||||
|
'sphinx.ext.napoleon',
|
||||||
|
'sphinx.ext.autosummary',
|
||||||
|
]
|
||||||
|
|
||||||
|
templates_path = ['_templates']
|
||||||
|
exclude_patterns = []
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for HTML output -------------------------------------------------
|
||||||
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||||||
|
|
||||||
|
html_theme = 'sphinx_rtd_theme'
|
||||||
|
html_static_path = ['_static']
|
||||||
8
docs/source/index.rst
Normal file
8
docs/source/index.rst
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
Welcome to SuperFaktura Client's documentation
|
||||||
|
=============================================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
superfaktura
|
||||||
|
installation
|
||||||
6
docs/source/installation.rst
Normal file
6
docs/source/installation.rst
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
Installation
|
||||||
|
====================
|
||||||
|
|
||||||
|
To install SuperFaktura Client, run the following command::
|
||||||
|
|
||||||
|
pip install git+https://github.com/eledio-helpers/superfaktura-client
|
||||||
7
docs/source/superfaktura.bank_account.rst
Normal file
7
docs/source/superfaktura.bank_account.rst
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
superfaktura.bank\_account module
|
||||||
|
=================================
|
||||||
|
|
||||||
|
.. automodule:: superfaktura.bank_account
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
7
docs/source/superfaktura.client_contacts.rst
Normal file
7
docs/source/superfaktura.client_contacts.rst
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
superfaktura.client\_contacts module
|
||||||
|
====================================
|
||||||
|
|
||||||
|
.. automodule:: superfaktura.client_contacts
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
7
docs/source/superfaktura.enumerations.currency.rst
Normal file
7
docs/source/superfaktura.enumerations.currency.rst
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
superfaktura.enumerations.currency module
|
||||||
|
=========================================
|
||||||
|
|
||||||
|
.. automodule:: superfaktura.enumerations.currency
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
21
docs/source/superfaktura.enumerations.rst
Normal file
21
docs/source/superfaktura.enumerations.rst
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
superfaktura.enumerations package
|
||||||
|
=================================
|
||||||
|
|
||||||
|
Submodules
|
||||||
|
----------
|
||||||
|
|
||||||
|
superfaktura.enumerations.currency module
|
||||||
|
-----------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: superfaktura.enumerations.currency
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
Module contents
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. automodule:: superfaktura.enumerations
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
7
docs/source/superfaktura.invoice.rst
Normal file
7
docs/source/superfaktura.invoice.rst
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
superfaktura.invoice module
|
||||||
|
===========================
|
||||||
|
|
||||||
|
.. automodule:: superfaktura.invoice
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
35
docs/source/superfaktura.rst
Normal file
35
docs/source/superfaktura.rst
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
SuperFaktura API client
|
||||||
|
====================
|
||||||
|
|
||||||
|
|
||||||
|
Bank account
|
||||||
|
---------------------------------
|
||||||
|
|
||||||
|
.. automodule:: superfaktura.bank_account
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
Client contacts
|
||||||
|
------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: superfaktura.client_contacts
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
Invoice
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. automodule:: superfaktura.invoice
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
SuperFaktura API
|
||||||
|
-------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: superfaktura.superfaktura_api
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
7
docs/source/superfaktura.superfaktura_api.rst
Normal file
7
docs/source/superfaktura.superfaktura_api.rst
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
superfaktura.superfaktura\_api module
|
||||||
|
=====================================
|
||||||
|
|
||||||
|
.. automodule:: superfaktura.superfaktura_api
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
7
docs/source/superfaktura.utils.country.rst
Normal file
7
docs/source/superfaktura.utils.country.rst
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
superfaktura.utils.country module
|
||||||
|
=================================
|
||||||
|
|
||||||
|
.. automodule:: superfaktura.utils.country
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
7
docs/source/superfaktura.utils.data_types.rst
Normal file
7
docs/source/superfaktura.utils.data_types.rst
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
superfaktura.utils.data\_types module
|
||||||
|
=====================================
|
||||||
|
|
||||||
|
.. automodule:: superfaktura.utils.data_types
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
29
docs/source/superfaktura.utils.rst
Normal file
29
docs/source/superfaktura.utils.rst
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
superfaktura.utils package
|
||||||
|
==========================
|
||||||
|
|
||||||
|
Submodules
|
||||||
|
----------
|
||||||
|
|
||||||
|
superfaktura.utils.country module
|
||||||
|
---------------------------------
|
||||||
|
|
||||||
|
.. automodule:: superfaktura.utils.country
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
superfaktura.utils.data\_types module
|
||||||
|
-------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: superfaktura.utils.data_types
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
Module contents
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. automodule:: superfaktura.utils
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
Reference in New Issue
Block a user