mirror of
https://github.com/IBM/ai-privacy-toolkit.git
synced 2026-06-17 15:35:13 +02:00
Documentation updates (#29)
* Bump version to 0.1.0 (breaking changes to some APIs) * Update documentation * Update requirements * gitignore
This commit is contained in:
parent
014aed9670
commit
fd6be8e778
12 changed files with 640 additions and 298 deletions
|
|
@ -32,8 +32,11 @@ master_doc = 'index'
|
|||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'sphinx.ext.duration',
|
||||
'sphinx.ext.doctest',
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.napoleon'
|
||||
'sphinx.ext.autosummary',
|
||||
'sphinx.ext.intersphinx',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
|
|
@ -50,7 +53,7 @@ exclude_patterns = []
|
|||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'alabaster'
|
||||
html_theme = 'pyramid'
|
||||
|
||||
# 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,
|
||||
|
|
|
|||
22
docs/source/apt.utils.datasets.rst
Normal file
22
docs/source/apt.utils.datasets.rst
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
apt.utils.datasets package
|
||||
==========================
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
apt.utils.datasets.datasets module
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: apt.utils.datasets.datasets
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: apt.utils.datasets
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
30
docs/source/apt.utils.models.rst
Normal file
30
docs/source/apt.utils.models.rst
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
apt.utils.models package
|
||||
========================
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
apt.utils.models.model module
|
||||
-----------------------------
|
||||
|
||||
.. automodule:: apt.utils.models.model
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
apt.utils.models.sklearn\_model module
|
||||
--------------------------------------
|
||||
|
||||
.. automodule:: apt.utils.models.sklearn_model
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: apt.utils.models
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
31
docs/source/apt.utils.rst
Normal file
31
docs/source/apt.utils.rst
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
apt.utils package
|
||||
=================
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
apt.utils.datasets
|
||||
apt.utils.models
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
apt.utils.dataset\_utils module
|
||||
-------------------------------
|
||||
|
||||
.. automodule:: apt.utils.dataset_utils
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: apt.utils
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
Loading…
Add table
Add a link
Reference in a new issue