diff --git a/.github/workflows/checks.yaml b/.github/workflows/checks.yaml index e298cbf2..82a1e38b 100644 --- a/.github/workflows/checks.yaml +++ b/.github/workflows/checks.yaml @@ -47,7 +47,7 @@ jobs: - name: Run tests run: python3 -m pytest - + lint: runs-on: ubuntu-latest steps: @@ -79,7 +79,7 @@ jobs: - name: Install dependencies run: | python3 -m pip install --upgrade pip - python3 -m pip install '.[docs]' + python3 -m pip install '.[docs,pg,etl]' - name: Attempt docs build working-directory: ./docs diff --git a/docs/source/index.rst b/docs/source/index.rst index d0569cb2..57ed3257 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -56,7 +56,7 @@ The Gene Normalizer was created to support the `Knowledgebase Integration Projec Usage Normalizing data Managing data - API Reference + API Reference Changelog Contributing License diff --git a/docs/source/api/api/gene.database.database.rst b/docs/source/reference/api/database/gene.database.database.rst similarity index 100% rename from docs/source/api/api/gene.database.database.rst rename to docs/source/reference/api/database/gene.database.database.rst diff --git a/docs/source/api/api/gene.database.dynamodb.rst b/docs/source/reference/api/database/gene.database.dynamodb.rst similarity index 100% rename from docs/source/api/api/gene.database.dynamodb.rst rename to docs/source/reference/api/database/gene.database.dynamodb.rst diff --git a/docs/source/api/api/gene.database.postgresql.rst b/docs/source/reference/api/database/gene.database.postgresql.rst similarity index 100% rename from docs/source/api/api/gene.database.postgresql.rst rename to docs/source/reference/api/database/gene.database.postgresql.rst diff --git a/docs/source/api/api/gene.etl.base.rst b/docs/source/reference/api/etl/gene.etl.base.rst similarity index 100% rename from docs/source/api/api/gene.etl.base.rst rename to docs/source/reference/api/etl/gene.etl.base.rst diff --git a/docs/source/api/api/gene.etl.ensembl.rst b/docs/source/reference/api/etl/gene.etl.ensembl.rst similarity index 100% rename from docs/source/api/api/gene.etl.ensembl.rst rename to docs/source/reference/api/etl/gene.etl.ensembl.rst diff --git a/docs/source/api/api/gene.etl.exceptions.rst b/docs/source/reference/api/etl/gene.etl.exceptions.rst similarity index 100% rename from docs/source/api/api/gene.etl.exceptions.rst rename to docs/source/reference/api/etl/gene.etl.exceptions.rst diff --git a/docs/source/api/api/gene.etl.hgnc.rst b/docs/source/reference/api/etl/gene.etl.hgnc.rst similarity index 100% rename from docs/source/api/api/gene.etl.hgnc.rst rename to docs/source/reference/api/etl/gene.etl.hgnc.rst diff --git a/docs/source/api/api/gene.etl.merge.rst b/docs/source/reference/api/etl/gene.etl.merge.rst similarity index 100% rename from docs/source/api/api/gene.etl.merge.rst rename to docs/source/reference/api/etl/gene.etl.merge.rst diff --git a/docs/source/api/api/gene.etl.ncbi.rst b/docs/source/reference/api/etl/gene.etl.ncbi.rst similarity index 100% rename from docs/source/api/api/gene.etl.ncbi.rst rename to docs/source/reference/api/etl/gene.etl.ncbi.rst diff --git a/docs/source/api/api/gene.query.rst b/docs/source/reference/api/gene.query.rst similarity index 100% rename from docs/source/api/api/gene.query.rst rename to docs/source/reference/api/gene.query.rst diff --git a/docs/source/api/api/gene.schemas.rst b/docs/source/reference/api/gene.schemas.rst similarity index 100% rename from docs/source/api/api/gene.schemas.rst rename to docs/source/reference/api/gene.schemas.rst diff --git a/docs/source/api/index.rst b/docs/source/reference/index.rst similarity index 81% rename from docs/source/api/index.rst rename to docs/source/reference/index.rst index dd956d90..8e0241ff 100644 --- a/docs/source/api/index.rst +++ b/docs/source/reference/index.rst @@ -1,7 +1,9 @@ +.. _api_reference: + API Reference ============= -Core functions +Core Modules -------------- .. autosummary:: @@ -12,24 +14,26 @@ Core functions gene.query gene.schemas -Database connections +Database Modules -------------------- .. autosummary:: :nosignatures: - :toctree: api/ + :toctree: api/database :template: module_summary.rst gene.database.database gene.database.dynamodb gene.database.postgresql -Source ETL +.. _etl-api: + +ETL Modules ---------- .. autosummary:: :nosignatures: - :toctree: api/ + :toctree: api/etl :template: module_summary.rst gene.etl.base