added readthedocs yml file

prasad-sawantdesai · Jan 17, 2025 · 2970b86 · 2970b86
1 parent f4ae1ef
commit 2970b86
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 3 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,23 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+  jobs:
+    post_checkout:
+      - git fetch --unshallow || true
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+        - netcdf
+        - h5py
+
+sphinx:
+  builder: html
+  configuration: docs/source/conf.py
+  fail_on_warning: false
diff --git a/docs/source/imas_architecture.rst b/docs/source/imas_architecture.rst
@@ -1,4 +1,4 @@
-imas-python Architecture
+imas-python architecture
 ========================
 
 This document provides a brief overview of the components of imas-python, grouped into

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,7 +3,7 @@
    define TOC here, but it'll be put in the sidebar by the theme
 
 ==================
-imas-python Manual
+imas-python manual
 ==================
 
 imas-python is a pure-python library to handle arbitrarily nested

diff --git a/pyproject.toml b/pyproject.toml
@@ -9,7 +9,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "imas-python"
 authors = [
-  {name = "imas-python Developers"},
+  {name = "imas-python developers"},
   {name = "Olivier Hoenen", email = "[email protected]"},
 ]
 description = "Pythonic wrappers for the IMAS Access Layer"
@@ -78,6 +78,7 @@ docs = [
     "sphinx-click",
 ]
 
+# TODO enable when imas-core is available on pypi
 # imas-core = [ "imas-core@git+https://github.com/iterorganization/imas-core.git@main" ]
 
 netcdf = [