Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs #22

Merged
merged 4 commits into from
Oct 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build

export SPHINX_APIDOC_OPTIONS=members,show-inheritance

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Expand All @@ -17,5 +19,6 @@ 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
sphinx-apidoc -o . ../src
# sphinx-apidoc -o . ../src
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
# rm --force `ls *.rst | grep --fixed-strings --invert-match index.rst`
8 changes: 6 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,16 @@

extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx.ext.viewcode"]

autodoc_default_options = {
"private-members": None,
"exclude-members": "model_config,model_fields",
}

templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]


# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "alabaster"
html_static_path = ["_static"]
html_theme = "sphinx_rtd_theme"
6 changes: 2 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,12 @@ Welcome to Intelligence Layer's documentation!
==============================================

.. toctree::
:maxdepth: 2
:maxdepth: 1
:caption: Contents:

modules
intelligence_layer

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

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
9 changes: 9 additions & 0 deletions docs/intelligence_layer.connectors.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
intelligence\_layer.connectors package
======================================

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

.. automodule:: intelligence_layer.connectors
:members:
:show-inheritance:
9 changes: 9 additions & 0 deletions docs/intelligence_layer.core.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
intelligence\_layer.core package
================================

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

.. automodule:: intelligence_layer.core
:members:
:show-inheritance:
19 changes: 19 additions & 0 deletions docs/intelligence_layer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
intelligence\_layer package
===========================

Subpackages
-----------

.. toctree::
:maxdepth: 3

intelligence_layer.connectors
intelligence_layer.core
intelligence_layer.use_cases

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

.. automodule:: intelligence_layer
:members:
:show-inheritance:
10 changes: 10 additions & 0 deletions docs/intelligence_layer.use_cases.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
intelligence\_layer.use\_cases package
======================================


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

.. automodule:: intelligence_layer.use_cases
:members:
:show-inheritance:
Loading