diff --git a/docs/source/api/diffpy.srfit.equation.literals.rst b/docs/source/api/diffpy.srfit.equation.literals.rst index 35b905b1..20679c3e 100644 --- a/docs/source/api/diffpy.srfit.equation.literals.rst +++ b/docs/source/api/diffpy.srfit.equation.literals.rst @@ -1,27 +1,34 @@ +:tocdepth: -1 + diffpy.srfit.equation.literals package ====================================== +.. automodule:: diffpy.srfit.equation.literals + :members: + :undoc-members: + :show-inheritance: + Submodules ---------- -diffpy.srfit.equation.literals.abcs module ------------------------------------------- +diffpy.srfit.equation.literals.argument module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.equation.literals.abcs +.. automodule:: diffpy.srfit.equation.literals.argument :members: :undoc-members: :show-inheritance: -diffpy.srfit.equation.literals.argument module ----------------------------------------------- +diffpy.srfit.equation.literals.abcs module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.equation.literals.argument +.. automodule:: diffpy.srfit.equation.literals.abcs :members: :undoc-members: :show-inheritance: diffpy.srfit.equation.literals.literal module ---------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.srfit.equation.literals.literal :members: @@ -29,18 +36,9 @@ diffpy.srfit.equation.literals.literal module :show-inheritance: diffpy.srfit.equation.literals.operators module ------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.srfit.equation.literals.operators :members: :undoc-members: :show-inheritance: - - -Module contents ---------------- - -.. automodule:: diffpy.srfit.equation.literals - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/api/diffpy.srfit.equation.rst b/docs/source/api/diffpy.srfit.equation.rst index f5642da1..ef74cf23 100644 --- a/docs/source/api/diffpy.srfit.equation.rst +++ b/docs/source/api/diffpy.srfit.equation.rst @@ -1,19 +1,27 @@ +:tocdepth: -1 + diffpy.srfit.equation package ============================= +.. automodule:: diffpy.srfit.equation + :members: + :undoc-members: + :show-inheritance: + Subpackages ----------- .. toctree:: + :titlesonly: - diffpy.srfit.equation.literals diffpy.srfit.equation.visitors + diffpy.srfit.equation.literals Submodules ---------- diffpy.srfit.equation.builder module ------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.srfit.equation.builder :members: @@ -21,18 +29,9 @@ diffpy.srfit.equation.builder module :show-inheritance: diffpy.srfit.equation.equationmod module ----------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.srfit.equation.equationmod :members: :undoc-members: :show-inheritance: - - -Module contents ---------------- - -.. automodule:: diffpy.srfit.equation - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/api/diffpy.srfit.equation.visitors.rst b/docs/source/api/diffpy.srfit.equation.visitors.rst index de17f93d..88c35374 100644 --- a/docs/source/api/diffpy.srfit.equation.visitors.rst +++ b/docs/source/api/diffpy.srfit.equation.visitors.rst @@ -1,54 +1,52 @@ +:tocdepth: -1 + diffpy.srfit.equation.visitors package ====================================== -Submodules ----------- - -diffpy.srfit.equation.visitors.argfinder module ------------------------------------------------ - -.. automodule:: diffpy.srfit.equation.visitors.argfinder +.. automodule:: diffpy.srfit.equation.visitors :members: :undoc-members: :show-inheritance: -diffpy.srfit.equation.visitors.printer module ---------------------------------------------- +Submodules +---------- -.. automodule:: diffpy.srfit.equation.visitors.printer +diffpy.srfit.equation.visitors.validator module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.srfit.equation.visitors.validator :members: :undoc-members: :show-inheritance: diffpy.srfit.equation.visitors.swapper module ---------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.srfit.equation.visitors.swapper :members: :undoc-members: :show-inheritance: -diffpy.srfit.equation.visitors.validator module ------------------------------------------------ +diffpy.srfit.equation.visitors.argfinder module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.equation.visitors.validator +.. automodule:: diffpy.srfit.equation.visitors.argfinder :members: :undoc-members: :show-inheritance: diffpy.srfit.equation.visitors.visitor module ---------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.srfit.equation.visitors.visitor :members: :undoc-members: :show-inheritance: +diffpy.srfit.equation.visitors.printer module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Module contents ---------------- - -.. automodule:: diffpy.srfit.equation.visitors +.. automodule:: diffpy.srfit.equation.visitors.printer :members: :undoc-members: :show-inheritance: diff --git a/docs/source/api/diffpy.srfit.fitbase.rst b/docs/source/api/diffpy.srfit.fitbase.rst index 44093442..19bc255e 100644 --- a/docs/source/api/diffpy.srfit.fitbase.rst +++ b/docs/source/api/diffpy.srfit.fitbase.rst @@ -1,142 +1,140 @@ +:tocdepth: -1 + diffpy.srfit.fitbase package ============================ -Submodules ----------- - -diffpy.srfit.fitbase.calculator module --------------------------------------- - -.. automodule:: diffpy.srfit.fitbase.calculator +.. automodule:: diffpy.srfit.fitbase :members: :undoc-members: :show-inheritance: -diffpy.srfit.fitbase.configurable module ----------------------------------------- +Submodules +---------- -.. automodule:: diffpy.srfit.fitbase.configurable +diffpy.srfit.fitbase.simplerecipe module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.srfit.fitbase.simplerecipe :members: :undoc-members: :show-inheritance: diffpy.srfit.fitbase.constraint module --------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.srfit.fitbase.constraint :members: :undoc-members: :show-inheritance: -diffpy.srfit.fitbase.fitcontribution module -------------------------------------------- - -.. automodule:: diffpy.srfit.fitbase.fitcontribution - :members: - :undoc-members: - :show-inheritance: - diffpy.srfit.fitbase.fithook module ------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.srfit.fitbase.fithook :members: :undoc-members: :show-inheritance: -diffpy.srfit.fitbase.fitrecipe module -------------------------------------- +diffpy.srfit.fitbase.fitresults module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.fitbase.fitrecipe +.. automodule:: diffpy.srfit.fitbase.fitresults :members: :undoc-members: :show-inheritance: -diffpy.srfit.fitbase.fitresults module --------------------------------------- +diffpy.srfit.fitbase.profilegenerator module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.fitbase.fitresults +.. automodule:: diffpy.srfit.fitbase.profilegenerator :members: :undoc-members: :show-inheritance: -diffpy.srfit.fitbase.parameter module -------------------------------------- +diffpy.srfit.fitbase.validatable module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.fitbase.parameter +.. automodule:: diffpy.srfit.fitbase.validatable :members: :undoc-members: :show-inheritance: -diffpy.srfit.fitbase.parameterset module ----------------------------------------- +diffpy.srfit.fitbase.configurable module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.fitbase.parameterset +.. automodule:: diffpy.srfit.fitbase.configurable :members: :undoc-members: :show-inheritance: diffpy.srfit.fitbase.profile module ------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.srfit.fitbase.profile :members: :undoc-members: :show-inheritance: -diffpy.srfit.fitbase.profilegenerator module --------------------------------------------- +diffpy.srfit.fitbase.restraint module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.fitbase.profilegenerator +.. automodule:: diffpy.srfit.fitbase.restraint :members: :undoc-members: :show-inheritance: -diffpy.srfit.fitbase.profileparser module ------------------------------------------ +diffpy.srfit.fitbase.fitcontribution module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.fitbase.profileparser +.. automodule:: diffpy.srfit.fitbase.fitcontribution :members: :undoc-members: :show-inheritance: diffpy.srfit.fitbase.recipeorganizer module -------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.srfit.fitbase.recipeorganizer :members: :undoc-members: :show-inheritance: -diffpy.srfit.fitbase.restraint module -------------------------------------- +diffpy.srfit.fitbase.fitrecipe module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.fitbase.restraint +.. automodule:: diffpy.srfit.fitbase.fitrecipe :members: :undoc-members: :show-inheritance: -diffpy.srfit.fitbase.simplerecipe module ----------------------------------------- +diffpy.srfit.fitbase.parameterset module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.fitbase.simplerecipe +.. automodule:: diffpy.srfit.fitbase.parameterset :members: :undoc-members: :show-inheritance: -diffpy.srfit.fitbase.validatable module ---------------------------------------- +diffpy.srfit.fitbase.calculator module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.fitbase.validatable +.. automodule:: diffpy.srfit.fitbase.calculator :members: :undoc-members: :show-inheritance: +diffpy.srfit.fitbase.parameter module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.srfit.fitbase.parameter + :members: + :undoc-members: + :show-inheritance: -Module contents ---------------- +diffpy.srfit.fitbase.profileparser module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.fitbase +.. automodule:: diffpy.srfit.fitbase.profileparser :members: :undoc-members: :show-inheritance: diff --git a/docs/source/api/diffpy.srfit.interface.rst b/docs/source/api/diffpy.srfit.interface.rst index 4b6296a8..92497fea 100644 --- a/docs/source/api/diffpy.srfit.interface.rst +++ b/docs/source/api/diffpy.srfit.interface.rst @@ -1,22 +1,20 @@ +:tocdepth: -1 + diffpy.srfit.interface package ============================== -Submodules ----------- - -diffpy.srfit.interface.interface module ---------------------------------------- - -.. automodule:: diffpy.srfit.interface.interface +.. automodule:: diffpy.srfit.interface :members: :undoc-members: :show-inheritance: +Submodules +---------- -Module contents ---------------- +diffpy.srfit.interface.interface module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.interface +.. automodule:: diffpy.srfit.interface.interface :members: :undoc-members: :show-inheritance: diff --git a/docs/source/api/diffpy.srfit.pdf.rst b/docs/source/api/diffpy.srfit.pdf.rst index a336a375..424c7f16 100644 --- a/docs/source/api/diffpy.srfit.pdf.rst +++ b/docs/source/api/diffpy.srfit.pdf.rst @@ -1,62 +1,60 @@ +:tocdepth: -1 + diffpy.srfit.pdf package ======================== +.. automodule:: diffpy.srfit.pdf + :members: + :undoc-members: + :show-inheritance: + Submodules ---------- -diffpy.srfit.pdf.basepdfgenerator module ----------------------------------------- +diffpy.srfit.pdf.debyepdfgenerator module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.pdf.basepdfgenerator +.. automodule:: diffpy.srfit.pdf.debyepdfgenerator :members: :undoc-members: :show-inheritance: diffpy.srfit.pdf.characteristicfunctions module ------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.srfit.pdf.characteristicfunctions :members: :undoc-members: :show-inheritance: -diffpy.srfit.pdf.debyepdfgenerator module ------------------------------------------ - -.. automodule:: diffpy.srfit.pdf.debyepdfgenerator - :members: - :undoc-members: - :show-inheritance: - -diffpy.srfit.pdf.pdfcontribution module ---------------------------------------- +diffpy.srfit.pdf.pdfparser module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.pdf.pdfcontribution +.. automodule:: diffpy.srfit.pdf.pdfparser :members: :undoc-members: :show-inheritance: diffpy.srfit.pdf.pdfgenerator module ------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.srfit.pdf.pdfgenerator :members: :undoc-members: :show-inheritance: -diffpy.srfit.pdf.pdfparser module ---------------------------------- +diffpy.srfit.pdf.basepdfgenerator module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.pdf.pdfparser +.. automodule:: diffpy.srfit.pdf.basepdfgenerator :members: :undoc-members: :show-inheritance: +diffpy.srfit.pdf.pdfcontribution module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Module contents ---------------- - -.. automodule:: diffpy.srfit.pdf +.. automodule:: diffpy.srfit.pdf.pdfcontribution :members: :undoc-members: :show-inheritance: diff --git a/docs/source/api/diffpy.srfit.rst b/docs/source/api/diffpy.srfit.rst index ebff42c6..8f840d0c 100644 --- a/docs/source/api/diffpy.srfit.rst +++ b/docs/source/api/diffpy.srfit.rst @@ -1,9 +1,7 @@ :tocdepth: -1 -|title| -======= - -.. |title| replace:: diffpy.srfit package +diffpy.srfit package +==================== .. automodule:: diffpy.srfit :members: @@ -14,12 +12,23 @@ Subpackages ----------- .. toctree:: - diffpy.srfit.equation - diffpy.srfit.equation.literals - diffpy.srfit.equation.visitors - diffpy.srfit.fitbase - diffpy.srfit.interface - diffpy.srfit.pdf - diffpy.srfit.sas - diffpy.srfit.structure - diffpy.srfit.util + :titlesonly: + + diffpy.srfit.interface + diffpy.srfit.equation + diffpy.srfit.util + diffpy.srfit.pdf + diffpy.srfit.sas + diffpy.srfit.fitbase + diffpy.srfit.structure + +Submodules +---------- + +diffpy.srfit.exceptions module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.srfit.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/diffpy.srfit.sas.rst b/docs/source/api/diffpy.srfit.sas.rst index 40f24b3d..8ad88d91 100644 --- a/docs/source/api/diffpy.srfit.sas.rst +++ b/docs/source/api/diffpy.srfit.sas.rst @@ -1,54 +1,60 @@ +:tocdepth: -1 + diffpy.srfit.sas package ======================== +.. automodule:: diffpy.srfit.sas + :members: + :undoc-members: + :show-inheritance: + Submodules ---------- -diffpy.srfit.sas.prcalculator module ------------------------------------- +diffpy.srfit.sas.sasparser module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.sas.prcalculator +.. automodule:: diffpy.srfit.sas.sasparser :members: :undoc-members: :show-inheritance: -diffpy.srfit.sas.sasgenerator module ------------------------------------- +diffpy.srfit.sas.prcalculator module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.sas.sasgenerator +.. automodule:: diffpy.srfit.sas.prcalculator :members: :undoc-members: :show-inheritance: -diffpy.srfit.sas.sasparameter module ------------------------------------- +diffpy.srfit.sas.sasprofile module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.sas.sasparameter +.. automodule:: diffpy.srfit.sas.sasprofile :members: :undoc-members: :show-inheritance: -diffpy.srfit.sas.sasparser module ---------------------------------- +diffpy.srfit.sas.sasparameter module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.sas.sasparser +.. automodule:: diffpy.srfit.sas.sasparameter :members: :undoc-members: :show-inheritance: -diffpy.srfit.sas.sasprofile module ----------------------------------- +diffpy.srfit.sas.sasimport module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.sas.sasprofile +.. automodule:: diffpy.srfit.sas.sasimport :members: :undoc-members: :show-inheritance: +diffpy.srfit.sas.sasgenerator module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Module contents ---------------- - -.. automodule:: diffpy.srfit.sas +.. automodule:: diffpy.srfit.sas.sasgenerator :members: :undoc-members: :show-inheritance: diff --git a/docs/source/api/diffpy.srfit.structure.rst b/docs/source/api/diffpy.srfit.structure.rst index 1bb5dd22..59063abd 100644 --- a/docs/source/api/diffpy.srfit.structure.rst +++ b/docs/source/api/diffpy.srfit.structure.rst @@ -1,70 +1,68 @@ +:tocdepth: -1 + diffpy.srfit.structure package ============================== +.. automodule:: diffpy.srfit.structure + :members: + :undoc-members: + :show-inheritance: + Submodules ---------- -diffpy.srfit.structure.basestructureparset module -------------------------------------------------- +diffpy.srfit.structure.objcrystparset module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.structure.basestructureparset +.. automodule:: diffpy.srfit.structure.objcrystparset :members: :undoc-members: :show-inheritance: -diffpy.srfit.structure.bvsrestraint module ------------------------------------------- +diffpy.srfit.structure.basestructureparset module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.structure.bvsrestraint +.. automodule:: diffpy.srfit.structure.basestructureparset :members: :undoc-members: :show-inheritance: -diffpy.srfit.structure.cctbxparset module ------------------------------------------ +diffpy.srfit.structure.srrealparset module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.structure.cctbxparset +.. automodule:: diffpy.srfit.structure.srrealparset :members: :undoc-members: :show-inheritance: diffpy.srfit.structure.diffpyparset module ------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.srfit.structure.diffpyparset :members: :undoc-members: :show-inheritance: -diffpy.srfit.structure.objcrystparset module --------------------------------------------- - -.. automodule:: diffpy.srfit.structure.objcrystparset - :members: - :undoc-members: - :show-inheritance: - -diffpy.srfit.structure.sgconstraints module -------------------------------------------- +diffpy.srfit.structure.cctbxparset module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.structure.sgconstraints +.. automodule:: diffpy.srfit.structure.cctbxparset :members: :undoc-members: :show-inheritance: -diffpy.srfit.structure.srrealparset module ------------------------------------------- +diffpy.srfit.structure.bvsrestraint module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.structure.srrealparset +.. automodule:: diffpy.srfit.structure.bvsrestraint :members: :undoc-members: :show-inheritance: +diffpy.srfit.structure.sgconstraints module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Module contents ---------------- - -.. automodule:: diffpy.srfit.structure +.. automodule:: diffpy.srfit.structure.sgconstraints :members: :undoc-members: :show-inheritance: diff --git a/docs/source/api/diffpy.srfit.util.rst b/docs/source/api/diffpy.srfit.util.rst index 64541ce6..2471e5ad 100644 --- a/docs/source/api/diffpy.srfit.util.rst +++ b/docs/source/api/diffpy.srfit.util.rst @@ -1,46 +1,60 @@ +:tocdepth: -1 + diffpy.srfit.util package ========================= +.. automodule:: diffpy.srfit.util + :members: + :undoc-members: + :show-inheritance: + Submodules ---------- diffpy.srfit.util.inpututils module ------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: diffpy.srfit.util.inpututils :members: :undoc-members: :show-inheritance: -diffpy.srfit.util.nameutils module ----------------------------------- +diffpy.srfit.util.observable module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.util.nameutils +.. automodule:: diffpy.srfit.util.observable :members: :undoc-members: :show-inheritance: -diffpy.srfit.util.observable module ------------------------------------ +diffpy.srfit.util.tagmanager module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.util.observable +.. automodule:: diffpy.srfit.util.tagmanager :members: :undoc-members: :show-inheritance: -diffpy.srfit.util.tagmanager module ------------------------------------ +diffpy.srfit.util.argbinders module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: diffpy.srfit.util.tagmanager +.. automodule:: diffpy.srfit.util.argbinders :members: :undoc-members: :show-inheritance: +diffpy.srfit.util.nameutils module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Module contents ---------------- +.. automodule:: diffpy.srfit.util.nameutils + :members: + :undoc-members: + :show-inheritance: -.. automodule:: diffpy.srfit.util +diffpy.srfit.util.weakrefcallable module +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: diffpy.srfit.util.weakrefcallable :members: :undoc-members: :show-inheritance: diff --git a/docs/source/conf.py b/docs/source/conf.py index aa4fd14b..6f33a1b7 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -55,6 +55,11 @@ "m2r2", ] +autodoc_mock_imports = [ + "diffpy.utils", + "pyobjcryst", +] + # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] diff --git a/news/api-doc-rerender.rst b/news/api-doc-rerender.rst new file mode 100644 index 00000000..dd860e07 --- /dev/null +++ b/news/api-doc-rerender.rst @@ -0,0 +1,23 @@ +**Added:** + +* No news needed: api doc rerendering + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*