diff --git a/docs/source/_templates/module_summary_inherited.rst b/docs/source/_templates/module_summary_inherited.rst new file mode 100644 index 00000000..0c7b84d5 --- /dev/null +++ b/docs/source/_templates/module_summary_inherited.rst @@ -0,0 +1,7 @@ +{{ fullname | underline }} + +.. automodule:: {{ fullname }} + :members: + :undoc-members: + :special-members: __init__ + :inherited-members: diff --git a/docs/source/managing_data/dynamodb.rst b/docs/source/managing_data/dynamodb.rst index ec67888a..ae8f8520 100644 --- a/docs/source/managing_data/dynamodb.rst +++ b/docs/source/managing_data/dynamodb.rst @@ -7,7 +7,7 @@ The Gene Normalizer can store and retrieve gene records from a `local DynamoDB < .. note:: - See the :ref:`DynamoDB handler API reference` for information on programmatic access. + See the :py:mod:`DynamoDB handler API reference` for information on programmatic access. Local setup ----------- diff --git a/docs/source/managing_data/postgresql.rst b/docs/source/managing_data/postgresql.rst index 71407fd3..4b33ebae 100644 --- a/docs/source/managing_data/postgresql.rst +++ b/docs/source/managing_data/postgresql.rst @@ -7,7 +7,7 @@ The Gene Normalizer can store and retrieve gene records from a `PostgreSQL ` for information on programmatic access. + See the :py:mod:`PostgreSQL handler API reference` for information on programmatic access. Local setup -------------- diff --git a/docs/source/reference/api/etl/gene.etl.base.rst b/docs/source/reference/api/etl/gene.etl.base.rst index 4864aef5..3a299652 100644 --- a/docs/source/reference/api/etl/gene.etl.base.rst +++ b/docs/source/reference/api/etl/gene.etl.base.rst @@ -5,4 +5,4 @@ :members: :undoc-members: :special-members: __init__ - :exclude-members: model_fields, model_config + :inherited-members: diff --git a/docs/source/reference/api/etl/gene.etl.ensembl.rst b/docs/source/reference/api/etl/gene.etl.ensembl.rst index ae311bd4..8095a543 100644 --- a/docs/source/reference/api/etl/gene.etl.ensembl.rst +++ b/docs/source/reference/api/etl/gene.etl.ensembl.rst @@ -5,4 +5,4 @@ :members: :undoc-members: :special-members: __init__ - :exclude-members: model_fields, model_config + :inherited-members: diff --git a/docs/source/reference/api/etl/gene.etl.exceptions.rst b/docs/source/reference/api/etl/gene.etl.exceptions.rst index 04cef4fb..992101ae 100644 --- a/docs/source/reference/api/etl/gene.etl.exceptions.rst +++ b/docs/source/reference/api/etl/gene.etl.exceptions.rst @@ -5,4 +5,4 @@ :members: :undoc-members: :special-members: __init__ - :exclude-members: model_fields, model_config + :inherited-members: diff --git a/docs/source/reference/api/etl/gene.etl.hgnc.rst b/docs/source/reference/api/etl/gene.etl.hgnc.rst index 3ae947dd..783e6ed3 100644 --- a/docs/source/reference/api/etl/gene.etl.hgnc.rst +++ b/docs/source/reference/api/etl/gene.etl.hgnc.rst @@ -5,4 +5,4 @@ :members: :undoc-members: :special-members: __init__ - :exclude-members: model_fields, model_config + :inherited-members: diff --git a/docs/source/reference/api/etl/gene.etl.merge.rst b/docs/source/reference/api/etl/gene.etl.merge.rst index 8cf9c905..ac508d3e 100644 --- a/docs/source/reference/api/etl/gene.etl.merge.rst +++ b/docs/source/reference/api/etl/gene.etl.merge.rst @@ -5,4 +5,4 @@ :members: :undoc-members: :special-members: __init__ - :exclude-members: model_fields, model_config + :inherited-members: diff --git a/docs/source/reference/api/etl/gene.etl.ncbi.rst b/docs/source/reference/api/etl/gene.etl.ncbi.rst index 00e92ea8..7c3240b3 100644 --- a/docs/source/reference/api/etl/gene.etl.ncbi.rst +++ b/docs/source/reference/api/etl/gene.etl.ncbi.rst @@ -5,4 +5,4 @@ :members: :undoc-members: :special-members: __init__ - :exclude-members: model_fields, model_config + :inherited-members: diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst index 8e0241ff..87759558 100644 --- a/docs/source/reference/index.rst +++ b/docs/source/reference/index.rst @@ -29,12 +29,12 @@ Database Modules .. _etl-api: ETL Modules ----------- +----------- .. autosummary:: :nosignatures: :toctree: api/etl - :template: module_summary.rst + :template: module_summary_inherited.rst gene.etl.base gene.etl.ensembl diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 8ba4ec96..b9261321 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -24,7 +24,7 @@ The individual endpoints are: Internal Python API ------------------- -Each search mode can be accessed directly within Python using the :ref:`query API`: +Each search mode can be accessed directly within Python using the :py:mod:`query API`: .. code-block:: pycon @@ -58,7 +58,7 @@ Users hoping for a more explicit connection declaration may instead call a datab ) q = QueryHandler(pg_db) -See the API documentation for the :ref:`database `, :ref:`DynamoDB `, and :ref:`PostgreSQL ` modules for more details. +See the API documentation for the :py:mod:`database `, :py:mod:`DynamoDB `, and :py:mod:`PostgreSQL ` modules for more details. Inputs ------ @@ -74,6 +74,7 @@ The **best match** for a search string is determined by which fields in a gene r :members: :undoc-members: :show-inheritance: + :noindex: .. note::