Skip to content

Commit

Permalink
feat: add generated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
cowan-macady committed Feb 7, 2023
1 parent 6ac4f1f commit d5581a4
Show file tree
Hide file tree
Showing 12 changed files with 407 additions and 253 deletions.
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -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)
29 changes: 29 additions & 0 deletions docs/authorization.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
authorization package
=====================

Submodules
----------

authorization.helper module
---------------------------

.. automodule:: authorization.helper
:members:
:undoc-members:
:show-inheritance:

authorization.is\_authorized module
-----------------------------------

.. automodule:: authorization.is_authorized
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: authorization
:members:
:undoc-members:
:show-inheritance:
58 changes: 58 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# 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('../indykite_sdk'))


# -- Project information -----------------------------------------------------

project = 'docs'
copyright = '2023, -'
author = '-'

# The full version, including alpha/beta/rc tags
release = '-'


# -- 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.ext.viewcode',
'sphinx.ext.napoleon'
]

# 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']


# -- 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'

# 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']
109 changes: 109 additions & 0 deletions docs/config.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
config package
==============

Submodules
----------

config.app\_space module
------------------------

.. automodule:: config.app_space
:members:
:undoc-members:
:show-inheritance:

config.application module
-------------------------

.. automodule:: config.application
:members:
:undoc-members:
:show-inheritance:

config.application\_agent module
--------------------------------

.. automodule:: config.application_agent
:members:
:undoc-members:
:show-inheritance:

config.application\_agent\_credential module
--------------------------------------------

.. automodule:: config.application_agent_credential
:members:
:undoc-members:
:show-inheritance:

config.config\_node module
--------------------------

.. automodule:: config.config_node
:members:
:undoc-members:
:show-inheritance:

config.customer module
----------------------

.. automodule:: config.customer
:members:
:undoc-members:
:show-inheritance:

config.helper module
--------------------

.. automodule:: config.helper
:members:
:undoc-members:
:show-inheritance:

config.oauth2\_application module
---------------------------------

.. automodule:: config.oauth2_application
:members:
:undoc-members:
:show-inheritance:

config.oauth2\_provider module
------------------------------

.. automodule:: config.oauth2_provider
:members:
:undoc-members:
:show-inheritance:

config.service\_account module
------------------------------

.. automodule:: config.service_account
:members:
:undoc-members:
:show-inheritance:

config.service\_account\_credential module
------------------------------------------

.. automodule:: config.service_account_credential
:members:
:undoc-members:
:show-inheritance:

config.tenant module
--------------------

.. automodule:: config.tenant
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: config
:members:
:undoc-members:
:show-inheritance:
93 changes: 93 additions & 0 deletions docs/identity.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
identity package
================

Submodules
----------

identity.change\_password module
--------------------------------

.. automodule:: identity.change_password
:members:
:undoc-members:
:show-inheritance:

identity.consent module
-----------------------

.. automodule:: identity.consent
:members:
:undoc-members:
:show-inheritance:

identity.delete module
----------------------

.. automodule:: identity.delete
:members:
:undoc-members:
:show-inheritance:

identity.enrich\_token module
-----------------------------

.. automodule:: identity.enrich_token
:members:
:undoc-members:
:show-inheritance:

identity.get\_digital\_twin module
----------------------------------

.. automodule:: identity.get_digital_twin
:members:
:undoc-members:
:show-inheritance:

identity.helper module
----------------------

.. automodule:: identity.helper
:members:
:undoc-members:
:show-inheritance:

identity.import\_digital\_twins module
--------------------------------------

.. automodule:: identity.import_digital_twins
:members:
:undoc-members:
:show-inheritance:

identity.introspect\_token module
---------------------------------

.. automodule:: identity.introspect_token
:members:
:undoc-members:
:show-inheritance:

identity.patch\_properties module
---------------------------------

.. automodule:: identity.patch_properties
:members:
:undoc-members:
:show-inheritance:

identity.verification module
----------------------------

.. automodule:: identity.verification
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: identity
:members:
:undoc-members:
:show-inheritance:
24 changes: 24 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. docs documentation master file, created by
sphinx-quickstart on Mon Feb 6 11:34:47 2023.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to docs's documentation!
================================

.. toctree::
:maxdepth: 4
:caption: Contents:

identity
config
authorization



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
35 changes: 35 additions & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions docs/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
authorization
=============

.. toctree::
:maxdepth: 4

authorization

Large diffs are not rendered by default.

0 comments on commit d5581a4

Please sign in to comment.