Skip to content

Commit

Permalink
📝 intersphinx setup
Browse files Browse the repository at this point in the history
  • Loading branch information
mraniki committed Aug 6, 2023
1 parent a8f64c4 commit 931d5f8
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 6 deletions.
3 changes: 1 addition & 2 deletions docs/01_start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ Example
The following example illustrate how to use the module


.. rli:: https://raw.githubusercontent.com/mraniki/findmyorder/main/examples/example.py
:language: python
.. literalinclude:: ../examples/example.py


5 changes: 2 additions & 3 deletions docs/02_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ Config

Setting available via settings.toml or .env


.. rli:: https://raw.githubusercontent.com/mraniki/findmyorder/main/findmyorder/default_settings.toml
:language: toml

.. literalinclude:: ../findmyorder/default_settings.toml


18 changes: 17 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,29 @@
'sphinx.ext.autosummary',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
'sphinxext.remoteliteralinclude',
"sphinx.ext.intersphinx",
]



# -- Extension configuration ---------------------------------------------------

intersphinx_mapping = {
"sphinx": ("https://www.sphinx-doc.org/en/master/", None),
# - :doc:`sphinx:usage/extensions/intersphinx`
"dynaconf": ("https://www.dynaconf.com", None),
"python": ("https://docs.python.org/3", None),
"talky": ("https://talky.readthedocs.io/en/latest/", None),
"talky-dev": ("https://talky.readthedocs.io/en/dev/", None),
"findmyorder": ("https://talky.readthedocs.io/projects/findmyorder/en/latest", None),
"dxsp": ("https://talky.readthedocs.io/projects/dxsp/en/latest", None),
"iamlistening": ("https://talky.readthedocs.io/projects/iamlistening/en/latest", None),
"talkytrend": ("https://talky.readthedocs.io/projects/talkytrend/en/latest", None),
"myllm": ("https://talky.readthedocs.io/projects/myllm/en/latest", None),
}

intersphinx_disabled_reftypes = ["*"]

napoleon_google_docstring = True
autosummary_generate = True
autoclass_content = 'both'
Expand Down

0 comments on commit 931d5f8

Please sign in to comment.