Skip to content

Commit d1b00b0

Browse files
martinburchellmartinburchell
committed
Update docs
1 parent b0520cb commit d1b00b0

File tree

8 files changed

+30
-56
lines changed

8 files changed

+30
-56
lines changed

‎docs/source/autodoc/_index.rst‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,9 @@ Automatic documentation of source code
6666
docker.py.rst
6767
dogpile_cache.py.rst
6868
dsp.py.rst
69-
email/mailboxpurge.py.rst
70-
email/sendmail.py.rst
71-
email/tests/sendmail_tests.py.rst
72-
ensure_test_executed_correctly.py.rst
69+
email_utils/mailboxpurge.py.rst
70+
email_utils/sendmail.py.rst
71+
email_utils/tests/sendmail_tests.py.rst
7372
enumlike.py.rst
7473
excel.py.rst
7574
exceptions.py.rst
@@ -82,8 +81,8 @@ Automatic documentation of source code
8281
httpconst.py.rst
8382
interval.py.rst
8483
iterhelp.py.rst
85-
json/serialize.py.rst
86-
json/typing_helpers.py.rst
84+
json_utils/serialize.py.rst
85+
json_utils/typing_helpers.py.rst
8786
lang.py.rst
8887
lists.py.rst
8988
logs.py.rst
@@ -104,7 +103,7 @@ Automatic documentation of source code
104103
plot.py.rst
105104
probability.py.rst
106105
process.py.rst
107-
profile.py.rst
106+
profiling.py.rst
108107
progress.py.rst
109108
psychiatry/drugs.py.rst
110109
psychiatry/mk_r_druglists.py.rst

docs/source/autodoc/email/mailboxpurge.py.rst renamed to docs/source/autodoc/email_utils/mailboxpurge.py.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. docs/source/autodoc/email/mailboxpurge.py.rst
1+
.. docs/source/autodoc/email_utils/mailboxpurge.py.rst
22
33
.. THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
44
@@ -18,8 +18,8 @@
1818
limitations under the License.
1919
2020
21-
cardinal_pythonlib.email.mailboxpurge
22-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21+
cardinal_pythonlib.email_utils.mailboxpurge
22+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2323

24-
.. automodule:: cardinal_pythonlib.email.mailboxpurge
24+
.. automodule:: cardinal_pythonlib.email_utils.mailboxpurge
2525
:members:

docs/source/autodoc/email/sendmail.py.rst renamed to docs/source/autodoc/email_utils/sendmail.py.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. docs/source/autodoc/email/sendmail.py.rst
1+
.. docs/source/autodoc/email_utils/sendmail.py.rst
22
33
.. THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
44
@@ -18,8 +18,8 @@
1818
limitations under the License.
1919
2020
21-
cardinal_pythonlib.email.sendmail
22-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21+
cardinal_pythonlib.email_utils.sendmail
22+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2323

24-
.. automodule:: cardinal_pythonlib.email.sendmail
24+
.. automodule:: cardinal_pythonlib.email_utils.sendmail
2525
:members:

docs/source/autodoc/email/tests/sendmail_tests.py.rst renamed to docs/source/autodoc/email_utils/tests/sendmail_tests.py.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. docs/source/autodoc/email/tests/sendmail_tests.py.rst
1+
.. docs/source/autodoc/email_utils/tests/sendmail_tests.py.rst
22
33
.. THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
44
@@ -18,8 +18,8 @@
1818
limitations under the License.
1919
2020
21-
cardinal_pythonlib.email.tests.sendmail_tests
22-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21+
cardinal_pythonlib.email_utils.tests.sendmail_tests
22+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2323

24-
.. automodule:: cardinal_pythonlib.email.tests.sendmail_tests
24+
.. automodule:: cardinal_pythonlib.email_utils.tests.sendmail_tests
2525
:members:

‎docs/source/autodoc/ensure_test_executed_correctly.py.rst‎

Lines changed: 0 additions & 25 deletions
This file was deleted.

docs/source/autodoc/json/serialize.py.rst renamed to docs/source/autodoc/json_utils/serialize.py.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. docs/source/autodoc/json/serialize.py.rst
1+
.. docs/source/autodoc/json_utils/serialize.py.rst
22
33
.. THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
44
@@ -18,8 +18,8 @@
1818
limitations under the License.
1919
2020
21-
cardinal_pythonlib.json.serialize
22-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21+
cardinal_pythonlib.json_utils.serialize
22+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2323

24-
.. automodule:: cardinal_pythonlib.json.serialize
24+
.. automodule:: cardinal_pythonlib.json_utils.serialize
2525
:members:

docs/source/autodoc/json/typing_helpers.py.rst renamed to docs/source/autodoc/json_utils/typing_helpers.py.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. docs/source/autodoc/json/typing_helpers.py.rst
1+
.. docs/source/autodoc/json_utils/typing_helpers.py.rst
22
33
.. THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
44
@@ -18,8 +18,8 @@
1818
limitations under the License.
1919
2020
21-
cardinal_pythonlib.json.typing_helpers
22-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21+
cardinal_pythonlib.json_utils.typing_helpers
22+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2323

24-
.. automodule:: cardinal_pythonlib.json.typing_helpers
24+
.. automodule:: cardinal_pythonlib.json_utils.typing_helpers
2525
:members:

docs/source/autodoc/profile.py.rst renamed to docs/source/autodoc/profiling.py.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. docs/source/autodoc/profile.py.rst
1+
.. docs/source/autodoc/profiling.py.rst
22
33
.. THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
44
@@ -18,8 +18,8 @@
1818
limitations under the License.
1919
2020
21-
cardinal_pythonlib.profile
22-
~~~~~~~~~~~~~~~~~~~~~~~~~~
21+
cardinal_pythonlib.profiling
22+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2323

24-
.. automodule:: cardinal_pythonlib.profile
24+
.. automodule:: cardinal_pythonlib.profiling
2525
:members:

0 commit comments

Comments
 (0)