Skip to content

Commit db4fefa

Browse files
committed
Updated docs.
1 parent 96280cd commit db4fefa

File tree

6 files changed

+62
-19
lines changed

6 files changed

+62
-19
lines changed

README.rst

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,17 @@ domdf_python_tools
1717
* - Docs
1818
- |docs| |docs_check|
1919
* - Tests
20-
- |actions_linux| |actions_windows| |actions_macos| |coveralls| |codefactor| |pre_commit_ci|
20+
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
2121
* - PyPI
2222
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
2323
* - Anaconda
2424
- |conda-version| |conda-platform|
2525
* - Activity
26-
- |commits-latest| |commits-since| |maintained|
26+
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
27+
* - QA
28+
- |codefactor| |actions_flake8| |actions_mypy| |pre_commit_ci|
2729
* - Other
28-
- |license| |language| |requires| |pre_commit|
30+
- |license| |language| |requires|
2931

3032
.. |docs| image:: https://img.shields.io/readthedocs/domdf_python_tools/latest?logo=read-the-docs
3133
:target: https://domdf_python_tools.readthedocs.io/en/latest
@@ -47,6 +49,14 @@ domdf_python_tools
4749
:target: https://github.com/domdfcoding/domdf_python_tools/actions?query=workflow%3A%22macOS%22
4850
:alt: macOS Test Status
4951

52+
.. |actions_flake8| image:: https://github.com/domdfcoding/domdf_python_tools/workflows/Flake8/badge.svg
53+
:target: https://github.com/domdfcoding/domdf_python_tools/actions?query=workflow%3A%22Flake8%22
54+
:alt: Flake8 Status
55+
56+
.. |actions_mypy| image:: https://github.com/domdfcoding/domdf_python_tools/workflows/mypy/badge.svg
57+
:target: https://github.com/domdfcoding/domdf_python_tools/actions?query=workflow%3A%22mypy%22
58+
:alt: mypy status
59+
5060
.. |requires| image:: https://requires.io/github/domdfcoding/domdf_python_tools/requirements.svg?branch=master
5161
:target: https://requires.io/github/domdfcoding/domdf_python_tools/requirements/?branch=master
5262
:alt: Requirements Status
@@ -101,9 +111,9 @@ domdf_python_tools
101111
.. |maintained| image:: https://img.shields.io/maintenance/yes/2020
102112
:alt: Maintenance
103113

104-
.. |pre_commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
105-
:target: https://github.com/pre-commit/pre-commit
106-
:alt: pre-commit
114+
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/domdf_python_tools
115+
:target: https://pypi.org/project/domdf_python_tools/
116+
:alt: PyPI - Downloads
107117

108118
.. |pre_commit_ci| image:: https://results.pre-commit.ci/badge/github/domdfcoding/domdf_python_tools/master.svg
109119
:target: https://results.pre-commit.ci/latest/github/domdfcoding/domdf_python_tools/master
@@ -133,8 +143,8 @@ To install with ``conda``:
133143

134144
.. code-block:: bash
135145
136-
$ conda config --add channels http://conda.anaconda.org/domdfcoding
137146
$ conda config --add channels http://conda.anaconda.org/conda-forge
147+
$ conda config --add channels http://conda.anaconda.org/domdfcoding
138148
139149
* Then install
140150

doc-source/api/bases.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@
66
:autosummary-members:
77
:no-members:
88

9+
Type Variables
10+
------------------
11+
12+
.. autotypevar:: domdf_python_tools.bases._F
13+
.. autotypevar:: domdf_python_tools.bases._LU
14+
.. autotypevar:: domdf_python_tools.bases._S
15+
.. autotypevar:: domdf_python_tools.bases._T
16+
.. autotypevar:: domdf_python_tools.bases._V
17+
18+
919
Dictable
1020
---------
1121

@@ -58,3 +68,18 @@ This avoids any potential issues with `mypy <http://mypy-lang.org/>`_
5868
.. autoclass:: domdf_python_tools.bases.NamedList
5969

6070
.. autofunction:: domdf_python_tools.bases.namedlist
71+
72+
73+
UserFloat
74+
------------
75+
76+
.. autoclass:: domdf_python_tools.bases.UserFloat
77+
:inherited-members:
78+
:special-members:
79+
:exclude-members: __ceil__,__floor__,conjugate,imag,real
80+
81+
82+
Lineup
83+
---------
84+
85+
.. autoclass:: domdf_python_tools.bases.Lineup

doc-source/api/terminal.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@
55
.. automodule:: domdf_python_tools.terminal
66
:undoc-members:
77
:special-members:
8+
:exclude-members: get_terminal_size

doc-source/api/terminal_colours.rst

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

doc-source/index.rst

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,17 @@ domdf_python_tools
1818
* - Docs
1919
- |docs| |docs_check|
2020
* - Tests
21-
- |actions_linux| |actions_windows| |actions_macos| |coveralls| |codefactor| |pre_commit_ci|
21+
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
2222
* - PyPI
2323
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
2424
* - Anaconda
2525
- |conda-version| |conda-platform|
2626
* - Activity
27-
- |commits-latest| |commits-since| |maintained|
27+
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
28+
* - QA
29+
- |codefactor| |actions_flake8| |actions_mypy| |pre_commit_ci|
2830
* - Other
29-
- |license| |language| |requires| |pre_commit|
31+
- |license| |language| |requires|
3032

3133
.. |docs| rtfd-shield::
3234
:project: domdf_python_tools
@@ -48,6 +50,14 @@ domdf_python_tools
4850
:workflow: macOS
4951
:alt: macOS Test Status
5052

53+
.. |actions_flake8| actions-shield::
54+
:workflow: Flake8
55+
:alt: Flake8 Status
56+
57+
.. |actions_mypy| actions-shield::
58+
:workflow: mypy
59+
:alt: mypy status
60+
5161
.. |requires| requires-io-shield::
5262
:alt: Requirements Status
5363

@@ -104,8 +114,10 @@ domdf_python_tools
104114
.. |maintained| maintained-shield:: 2020
105115
:alt: Maintenance
106116

107-
.. |pre_commit| pre-commit-shield::
108-
:alt: pre-commit
117+
.. |pypi-downloads| pypi-shield::
118+
:project: domdf_python_tools
119+
:downloads: month
120+
:alt: PyPI - Downloads
109121

110122
.. |pre_commit_ci| pre-commit-ci-shield::
111123
:alt: pre-commit.ci status
@@ -122,7 +134,7 @@ Installation
122134
:pypi:
123135
:github:
124136
:anaconda:
125-
:conda-channels: domdfcoding, conda-forge
137+
:conda-channels: conda-forge, domdfcoding
126138

127139
.. end installation
128140

doc-source/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
autodocsumm>=0.2.0
22
default-values>=0.2.0
3-
domdf-sphinx-theme>=0.1.0
3+
domdf-sphinx-theme>=0.3.0
44
extras-require>=0.2.0
55
pandas>=1.1.2
66
seed-intersphinx-mapping>=0.1.1

0 commit comments

Comments
 (0)