Skip to content

Commit

Permalink
Export symbols in base packages
Browse files Browse the repository at this point in the history
With this also explicitly add wanted rst files instead of generating
on each build.
  • Loading branch information
volkerstampa committed Oct 30, 2023
1 parent 02c06eb commit 223ce90
Show file tree
Hide file tree
Showing 12 changed files with 352 additions and 24 deletions.
6 changes: 4 additions & 2 deletions 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,6 +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`
# rm --force `ls *.rst | grep --fixed-strings --invert-match index.rst`
3 changes: 1 addition & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,4 @@
# -- 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

0 comments on commit 223ce90

Please sign in to comment.