Merge pull request #5 from UNSW-CEEM/poetry-for-docs

Poetry for docs
UNSW-CEEM · Jul 27, 2022 · ffcd164 · ffcd164
2 parents 6a5785b + 623ae4c
commit ffcd164
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 59 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -10,6 +10,11 @@ build:
   os: ubuntu-20.04
   tools:
     python: "3.9"
+  jobs:
+    post_install:
+      - pip install poetry==1.2.0b2
+      - poetry config virtualenvs.create false
+      - poetry install --with=docs
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
@@ -18,8 +23,3 @@ sphinx:
 # If using Sphinx, optionally build your docs in additional formats such as PDFf
 formats:
    - pdf
-
-# Optionally declare the Python requirements required to build your docs
-python:
-   install:
-   - requirements: docs/requirements.txt
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/source/api.md b/docs/source/api.md
@@ -7,7 +7,7 @@
 ## Loader
 
 :::{note}
-Use the {meth}`initialise() <nemseer.loader.Loader.initialise()>` class method to create an instance of the {class}`Loader` object, as this method assembles metadata relevant to NEMSEER cache searching.
+Use the {meth}`initialise() <nemseer.loader.Loader.initialise()>` class method to create an instance of the {class}`Loader <nemseer.loader.Loader>` object, as this method assembles metadata relevant to NEMSEER cache searching.
 :::
 
 ```{eval-rst}
@@ -18,7 +18,7 @@ Use the {meth}`initialise() <nemseer.loader.Loader.initialise()>` class method t
 ## Downloader
 
 :::{note}
-Use the {meth}`from_Loader() <nemseer.downloader.ForecastTypeDownloader.from_Loader()>` class method to create an instance of the {class}`ForecastTypeLoader` object.
+Use the {meth}`from_Loader() <nemseer.downloader.ForecastTypeDownloader.from_Loader()>` class method to create an instance of the {class}`ForecastTypeLoader <nemseer.downloader.ForecastTypeDownloader>` object.
 :::
 
 ```{eval-rst}