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.

Sign up for GitHub

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

Jump to bottom

📝 intersphinx setup #262

Merged
merged 1 commit into from
Aug 6, 2023
+20 −6
Merged

📝 intersphinx setup #262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 1 addition & 2 deletions docs/01_start.rst
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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