Merge branch 'main' into 2339-fix-footgun

Author: shyuep

.github/workflows/jekyll-gh-pages.yml

@@ -24,7 +24,30 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
+        with:
+          submodules: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install pymatgen with docs dependencies
+        run: |
+          pip install -e ".[docs]"
+          pip install sphinx sphinx-rtd-theme sphinx_markdown_builder
+
+      - name: Generate Sphinx API docs
+        working-directory: docs
+        run: |
+          echo ".. This file is required as the Sphinx master_doc entry point. Content is generated by sphinx-apidoc." > apidoc/index.rst
+          sphinx-apidoc --implicit-namespaces -M -d 7 -o apidoc -f ../src/pymatgen
+          sphinx-build -b html apidoc html
+          rm -rf .apidoc_merge
+          rm apidoc/*.rst
+          mv html/pymatgen*.html .
+          mv html/modules.html .
 
       - name: Setup Pages
         uses: actions/configure-pages@v5

.pre-commit-config.yaml

@@ -1,4 +1,4 @@
-exclude: ^(docs|tests/files|tasks.py)
+exclude: ^(docs|tests/files|test-files|tasks.py)
 
 ci:
   autoupdate_schedule: monthly

docs/CHANGES.md

@@ -1,22 +1,34 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.7.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activesupport (7.2.3.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    addressable (2.8.4)
-      public_suffix (>= 2.0.2, < 6.0)
+      logger (>= 1.4.2)
+      minitest (>= 5.1, < 6)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
+    base64 (0.3.0)
+    benchmark (0.5.0)
+    bigdecimal (4.1.1)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
     coffee-script-source (1.11.1)
     colorator (1.1.0)
     commonmarker (0.23.10)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.3.6)
+    connection_pool (3.0.2)
     dnsruby (1.70.0)
       simpleidn (~> 0.2.1)
+    drb (2.2.3)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
@@ -88,7 +100,7 @@ GEM
       activesupport (>= 2)
       nokogiri (>= 1.4)
     http_parser.rb (0.8.0)
-    i18n (1.14.1)
+    i18n (1.14.8)
       concurrent-ruby (~> 1.0)
     jekyll (3.9.3)
       addressable (~> 2.4)
@@ -198,7 +210,7 @@ GEM
       gemoji (~> 3.0)
       html-pipeline (~> 2.2)
       jekyll (>= 3.0, < 5.0)
-    json (2.18.1)
+    json (2.19.2)
     kramdown (2.3.2)
       rexml
     kramdown-parser-gfm (1.1.0)
@@ -213,7 +225,7 @@ GEM
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
-    minitest (5.19.0)
+    minitest (5.27.0)
     net-http (0.9.1)
       uri (>= 0.11.1)
     nokogiri (1.19.1-arm64-darwin)
@@ -242,6 +254,7 @@ GEM
     sawyer (0.9.2)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
+    securerandom (0.4.1)
     simpleidn (0.2.1)
       unf (~> 0.1.4)
     terminal-table (1.8.0)