Merge pull request #118 from minijackson/sphinx-docs

Migrate to Sphinx docs
epics-extensions · Jul 29, 2024 · 92497c1 · 92497c1
2 parents 10c2d54 + 63bdfa3
commit 92497c1
Show file tree

Hide file tree

Showing 249 changed files with 2,903 additions and 2,358 deletions.
diff --git a/.github/workflows/book-gh-pages.yml b/.github/workflows/book-gh-pages.yml
@@ -27,8 +27,8 @@ jobs:
       - uses: cachix/install-nix-action@ba0dd844c9180cbf77aa72a116d6fbc515d0e87b # v27
       - name: "Build documentation book"
         run: |
-          nix build '.#book' --print-build-logs
-          cp -Lr --no-preserve=mode,ownership ./result/ ./book
+          nix build '.#docs' --print-build-logs
+          cp -Lr --no-preserve=mode,ownership ./result/share/doc/epnix/html ./book
       - name: Setup Pages
         uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
       - name: Upload artifact

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -31,8 +31,8 @@ formatting:
 manpages:
   stage: deploy
   script:
-    - nix build $NIX_BUILD_FLAGS '.#manpages'
-    - cp -Lr ./result manpages
+    - nix build $NIX_BUILD_FLAGS '.#docs'
+    - cp -Lr ./result/share/man manpages
   artifacts:
     name: "manpages-$CI_COMMIT_REF_SLUG"
     paths:
@@ -41,8 +41,8 @@ manpages:
 pages:
   stage: deploy
   script:
-    - nix build $NIX_BUILD_FLAGS '.#book'
-    - cp -Lr ./result public
+    - nix build $NIX_BUILD_FLAGS '.#docs'
+    - cp -Lr ./result/share/doc/epnix/html public
   artifacts:
     name: "book"
     paths:

diff --git a/.vale.ini b/.vale.ini
@@ -1,12 +1,12 @@
-StylesPath = doc/_vale
+StylesPath = docs/_vale
 MinAlertLevel = suggestion
 
 Vocab = EPNix
 
 # External packages
 Packages = alex, Google, Microsoft, proselint, RedHat, write-good
-# Only Markdown and .txt files; change to whatever you're using.
-[*.md]
+
+[*.{md,rst}]
 # List of styles to load.
 BasedOnStyles = alex, Google, Microsoft, proselint, RedHat, Vale, write-good
 

diff --git a/doc/.gitignore b/doc/.gitignore
diff --git a/doc/_quarto.yml b/doc/_quarto.yml
diff --git a/doc/index.md b/doc/index.md
diff --git a/doc/ioc/developer-guides.md b/doc/ioc/developer-guides.md
diff --git a/doc/ioc/developer-guides/glossary.md b/doc/ioc/developer-guides/glossary.md
diff --git a/doc/ioc/developer-guides/guidelines.md b/doc/ioc/developer-guides/guidelines.md
diff --git a/doc/ioc/developer-guides/packaging-modules.md b/doc/ioc/developer-guides/packaging-modules.md
diff --git a/doc/ioc/developer-guides/packaging.md b/doc/ioc/developer-guides/packaging.md
diff --git a/doc/ioc/developer-tutorials.md b/doc/ioc/developer-tutorials.md
diff --git a/doc/ioc/explanations.md b/doc/ioc/explanations.md
diff --git a/doc/ioc/faq.md b/doc/ioc/faq.md
diff --git a/doc/ioc/guides.md b/doc/ioc/guides.md