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

Move the backend docs and connect the config docs. Both in a single sidebar entry. #7389

Merged
merged 5 commits into from
Apr 5, 2024
Merged

Move the backend docs and connect the config docs. Both in a single sidebar entry. #7389

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ef12d53
make doc sidebar entry for backends and config
dschult Apr 4, 2024
4908a91
put _dispatchable into section heading name for ease of doc search
dschult Apr 4, 2024
9840799
add Config class to the docs
dschult Apr 4, 2024
e72d050
Change docs based on review comments and meeting discussions
dschult Apr 5, 2024
03abf69
move backend tests from classes/tests directory to utilities/test
dschult Apr 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 23 additions & 0 deletions doc/reference/backends.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
********************
Backends and Configs
********************

.. note:: Both NetworkX backend and config systems are experimental. They
let you execute an alternate backend implementation instead of NetworkX's
pure Python dictionaries implementation. Things will almost certainly
change and break in future releases!

Backends
--------
.. automodule:: networkx.utils.backends

Backend Decorators
------------------
.. autofunction:: _dispatchable

Configs
-------
.. automodule:: networkx.utils.configs

.. autoclass:: config
.. autoclass:: NetworkXConfig
1 change: 1 addition & 0 deletions doc/reference/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,5 @@ Reference
randomness
exceptions
utils
backends
glossary
12 changes: 0 additions & 12 deletions doc/reference/utils.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,15 +73,3 @@ Mapped Queue
:toctree: generated/

MappedQueue

Backends
--------
.. note:: NetworkX backends are experimental. They let you execute an alternate
backend implementation instead of NetworkX's pure Python dictionaries
implementation. Things will change and break in the future!

.. automodule:: networkx.utils.backends
.. autosummary::
:toctree: generated/

_dispatchable
4 changes: 2 additions & 2 deletions networkx/utils/configs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,8 +183,8 @@ class NetworkXConfig(Config):
>>> nx.config.backend_priority == nx.config["backend_priority"]
True

Config Parameters
-----------------
Parameters
----------
backend_priority : list of backend names
Enable automatic conversion of graphs to backend graphs for algorithms
implemented by the backend. Priority is given to backends listed earlier.
Expand Down