Initial commit

ethanc8 · ethanc8 · commit 12e52afba794 · 2025-02-04T11:55:52.000-06:00
diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml
@@ -0,0 +1,37 @@
+name: "Sphinx: Render docs"
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    defaults:
+      run:
+        shell: bash -el {0}
+        # GitHub configures `bash` to ignore ~/.bashrc and ~/.profile, but
+        # we can avoid this by using `bash -el {0}`
+        # see https://github.com/marketplace/actions/setup-miniconda and https://github.com/orgs/community/discussions/25061
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install Miniforge with dependencies
+      uses: conda-incubator/setup-miniconda@v3
+      with:
+        environment-file: environment.yml
+        miniforge-version: latest
+        use-mamba: true
+        auto-activate-base: false
+    - name: Build HTML
+      run: make html
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: html-docs
+        path: build/html/
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      if: github.ref == 'refs/heads/master'
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: build/html
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,9 @@
+build
+**/__pycache__
+
+# temporary files
+
+*.*~
+*~
+*.tmp
+*.swp
diff --git a/Makefile b/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/README.md b/README.md
@@ -0,0 +1,57 @@
+# Epoch documentation
+
+
+
+## Building
+### Installation of dependencies
+
+First, please have Conda installed on your computer. If it's not installed, please install [Miniforge3](https://conda-forge.org/miniforge/), which includes Conda and a conda-forge based Python environment. You can install Miniforge3 using the following command:
+
+```bash
+wget "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
+bash Miniforge3-$(uname)-$(uname -m).sh
+rm Miniforge3-$(uname)-$(uname -m).sh
+```
+
+Close and reopen your shell, and run:
+
+```bash
+# Prevent Conda from polluting your environment when you're not working on Conda-managed projects.
+conda config --set auto_activate_base false
+```
+
+Now, you can use Conda to install the dependencies.
+
+```bash
+mamba env create -f environment.yml
+mamba activate NewDocumentation
+```
+
+If you modify `environment.yml`, please run
+
+```bash
+mamba env update -f environment.yml
+```
+
+Occassionally, you should update all the packages to the latest versions:
+
+```bash
+mamba activate NewDocumentation
+mamba update --all
+```
+
+### Building
+
+To make the docs in HTML format, run:
+
+```bash
+make html
+```
+
+Then you can read it in your browser:
+
+```bash
+firefox build/html/index.html
+```
+
+There are other output formats, but they might not work.
diff --git a/environment.yml b/environment.yml
@@ -0,0 +1,15 @@
+name: NewDocumentation
+channels:
+  - conda-forge
+  - nodefaults
+dependencies:
+  - python
+  - pip
+  - sphinx>=8.0
+  - sphinx-design
+  - sphinx-copybutton
+  - furo
+  - pydata-sphinx-theme
+  - myst-parser
+  - pip:
+    - sphinxcontrib-domaintools
diff --git a/make.bat b/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/source/Architecture/index.md b/source/Architecture/index.md
@@ -0,0 +1,2 @@
+# Architecture
+
diff --git a/source/Operations/index.md b/source/Operations/index.md
@@ -0,0 +1,2 @@
+# Operations manual
+
diff --git a/source/User/index.md b/source/User/index.md
@@ -0,0 +1,3 @@
+# User manual
+
+
diff --git a/source/Worknotes/CloudOperationLogs/index.md b/source/Worknotes/CloudOperationLogs/index.md
@@ -0,0 +1,2 @@
+# Cloud operation logs
+
diff --git a/source/Worknotes/ClusterOperationLogs/index.md b/source/Worknotes/ClusterOperationLogs/index.md
@@ -0,0 +1,2 @@
+# Cluster operation logs
+
diff --git a/source/Worknotes/Meetings/index.md b/source/Worknotes/Meetings/index.md
@@ -0,0 +1,9 @@
+# Meetings
+
+:::{toctree}
+:maxdepth: 2
+:caption: Contents
+:titlesonly: true
+
+meeting20250203
+:::
diff --git a/source/Worknotes/Meetings/meeting20250203.md b/source/Worknotes/Meetings/meeting20250203.md
@@ -0,0 +1,3 @@
+# Planning meeting 2025-02-03
+
+
diff --git a/source/Worknotes/index.md b/source/Worknotes/index.md
@@ -0,0 +1,11 @@
+# Work notes
+
+:::{toctree}
+:maxdepth: 2
+:caption: Contents
+:titlesonly: true
+
+Meetings/index
+ClusterOperationLogs/index
+CloudOperationLogs/index
+:::
diff --git a/source/_ext/makedomain.py b/source/_ext/makedomain.py
@@ -0,0 +1,21 @@
+from sphinxcontrib.domaintools import custom_domain
+
+def setup(app):
+    app.add_domain(custom_domain('GnuMakeDomain',
+        name  = 'make',
+        label = "GNU Make",
+
+        elements = dict(
+            target = dict(
+                objname      = "Make Target",
+                indextemplate = "target %s",
+            ),
+            var   = dict(
+                objname = "Make Variable",
+                indextemplate = "pair %s"
+            ),
+        )))
+
+    return {
+        'version': '0.1',
+    }
diff --git a/source/conf.py b/source/conf.py
@@ -0,0 +1,71 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath("./_ext"))
+
+# -- Project information -----------------------------------------------------
+
+project = 'Epoch'
+copyright = '2025, Epoch members'
+author = 'Epoch members'
+
+# The full version, including alpha/beta/rc tags
+release = '1.0'
+html_title = 'Epoch'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'myst_parser', # Markdown support
+    'sphinx_design', # Grids, cards, icons, etc.
+    'sphinx_copybutton', # Copy button to the right of code blocks
+    'makedomain', # Domain to document GNUstep Make
+]
+myst_enable_extensions = [
+    'colon_fence'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'furo'
+# html_theme = 'pydata_sphinx_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+html_extra_path = ['RawHTML']
+
+myst_footnote_transition = False
+
+html_css_files = [
+    "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.7.1/css/all.min.css"
+]
diff --git a/source/index.md b/source/index.md
@@ -0,0 +1,13 @@
+# Epoch documentation
+
+:::{toctree}
+:maxdepth: 2
+:caption: Contents
+:titlesonly: true
+
+User/index
+Architecture/index
+Operations/index
+Worknotes/index
+:::
+

-Original file line number
+Diff line change
@@ @@ -0,0 +1,9 @@ @@
 +build
 +**/__pycache__
++
 +# temporary files
++
 +*.*~
 +*~
 +*.tmp
 +*.swp