Skip to content

Use fully-qualified names in autodoc directives #1882

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

Merged
merged 3 commits into from
Oct 22, 2024
Merged

Use fully-qualified names in autodoc directives #1882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d7bef7b
Use fully-qualified names in autodoc directives
AA-Turner Oct 22, 2024
44bf0e0
Merge branch 'master' into improve-autodoc
nedbat Oct 22, 2024
6d65e41
docs: thanks, Adam!
nedbat Oct 22, 2024
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
1 change: 1 addition & 0 deletions CONTRIBUTORS.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Other contributions, including writing code, updating docs, and submitting
useful bug reports, have been made by:

Abdeali Kothari
Adam Turner
Adi Roiban
Agbonze O. Jeremiah
Albertas Agejevas
Expand Down
5 changes: 1 addition & 4 deletions doc/api_coverage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@
The Coverage class
------------------

.. module:: coverage
:noindex:

.. autoclass:: Coverage
.. autoclass:: coverage.Coverage
:members:
:exclude-members: sys_info
:special-members: __init__
5 changes: 1 addition & 4 deletions doc/api_coveragedata.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ The CoverageData class

.. versionadded:: 4.0

.. module:: coverage
:no-index:

.. autoclass:: CoverageData
.. autoclass:: coverage.CoverageData
:members:
:special-members: __init__
7 changes: 1 addition & 6 deletions doc/api_exceptions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,6 @@
Coverage exceptions
-------------------

.. module:: coverage.exceptions

.. autoclass:: CoverageException

.. automodule:: coverage.exceptions
:no-index:
:members:
:exclude-members: CoverageException
:member-order: bysource
4 changes: 2 additions & 2 deletions doc/api_module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ available by name.

A string with the version of coverage.py, for example, ``"5.0b2"``.

.. autoclass:: CoverageException
.. autoexception:: coverage.CoverageException


Starting coverage.py automatically
Expand All @@ -35,4 +35,4 @@ Starting coverage.py automatically
This function is used to start coverage measurement automatically when Python
starts. See :ref:`subprocess` for details.

.. autofunction:: process_startup
.. autofunction:: coverage.process_startup
11 changes: 4 additions & 7 deletions doc/api_plugin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,33 +9,30 @@ Plug-in classes

.. automodule:: coverage.plugin

.. module:: coverage
:no-index:

The CoveragePlugin class
------------------------

.. autoclass:: CoveragePlugin
.. autoclass:: coverage.CoveragePlugin
:members:
:member-order: bysource

The FileTracer class
--------------------

.. autoclass:: FileTracer
.. autoclass:: coverage.FileTracer
:members:
:member-order: bysource

The FileReporter class
----------------------

.. autoclass:: FileReporter
.. autoclass:: coverage.FileReporter
:members:
:member-order: bysource

The CodeRegion class
--------------------

.. autoclass:: CodeRegion
.. autoclass:: coverage.CodeRegion
:members:
:member-order: bysource