Fix for the readthedocs documentation rendering issue (#112)

* fixing the docs render issue * docs configuration updates * readthedocs config updates * fixing the docs dependency * fixing python version * fixing python version * add tenacity dependency * add pydantic_settings dependency * fixing the docs strings * updates to readthedocs config file * Updates to changelog
cognitedata · Nov 17, 2023 · 3f20a56 · 3f20a56
1 parent e669500
commit 3f20a56
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 13 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -1,13 +1,14 @@
 version: 2
 
 build:
-  image: latest
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
 
 python:
-  version: 3.8
   install:
     - requirements: docs/requirements.txt
 
 sphinx:
-  fail_on_warning: false
+  fail_on_warning: true
   configuration: docs/source/conf.py
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -150,4 +150,12 @@ Changes are grouped as follows
 ## [0.3.0] - 2023-11-16
 
 ### Fixed
+- Support for cognite-sdk 7.x.x + versions.
 - Dependency updates for docs & source code.
+
+## [0.3.1] - 2023-11-17
+
+### Fixed
+- Fixes to render the readthedocs documentation properly.
+- Dependency updates for docs & source code.
+
diff --git a/cognite/cdffs/__init__.py b/cognite/cdffs/__init__.py
@@ -3,7 +3,7 @@
 
 from .spec import CdfFileSystem
 
-__version__ = "0.3.0"
+__version__ = "0.3.1"
 __all__ = ["CdfFileSystem"]
 
 fsspec.register_implementation(CdfFileSystem.protocol, CdfFileSystem)
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -3,3 +3,6 @@ fsspec==2023.10.0
 cognite-sdk==7.1.0
 requests==2.31.0
 pydantic==2.5.1
+sphinx-rtd-theme==1.3.0
+tenacity==8.2.3
+pydantic_settings==2.1.0
diff --git a/docs/source/cdffs.rst b/docs/source/cdffs.rst
@@ -1,7 +1,7 @@
-Cognite cdffs
-=============
+cdffs
+=====
 
-A file-system interface to allow users to work with CDF Files using the fsspec supported/compatible python packages.
+A file-system interface to allow users to work with CDF (Cognite Data Fusion) Files using the fsspec supported/compatible python packages.
 
 `fsspec` provides an abstract file system interface to work with local/cloud storages and based on the
 protocol name (example, `s3` or `abfs`) provided in the path, `fsspec` translates the incoming requests

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -22,7 +22,7 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["sphinx_rtd_theme", "sphinx.ext.autosummary", "sphinx.ext.autodoc"]
+extensions = ["sphinx_rtd_theme", "sphinx.ext.autosummary", "sphinx.ext.napoleon"]
 
 exclude_patterns = []
 autosummary_generate = True

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,7 +1,7 @@
 Welcome to cognite-cdffs's documentation!
 =========================================
 
-A file-system interface (`cdffs`) to allow users to work with CDF Files using `fsspec <https://filesystem-spec.readthedocs.io/en/latest/>`_
+A file-system interface (`cdffs`) that allow users to work with CDF (Cognite Data Fusion) Files using `fsspec <https://filesystem-spec.readthedocs.io/en/latest/>`_
 supported/compatible python packages (`pandas`, `xarray` etc). `cdffs` uses `cognite-sdk-python <https://cognite-sdk-python.readthedocs-hosted.com/en/latest/index.html>`_ to work with CDF Files.
 
 Refer `fsspec documentation <https://filesystem-spec.readthedocs.io/en/latest/#who-uses-fsspec>`_ to get

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cognite-cdffs"
-version = "0.3.0"
+version = "0.3.1"
 description = "File System Interface for CDF Files"
 license = "Apache-2.0"
 authors = ["Infant Alex <[email protected]>"]