Merge pull request #2 from jjscheel/main

Complete foundation

.github/workflows/doc-build.yml

@@ -0,0 +1,27 @@
+name: doc-build
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx_rtd_theme myst_parser
+      - name: Sphinx build
+        run: |
+          make html
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/html
+          force_orphan: true

.gitignore

@@ -27,7 +27,7 @@ __pycache__/
 
 # Distribution / packaging
 .Python
-#build/
+build/
 develop-eggs/
 dist/
 downloads/
@@ -88,7 +88,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+docs/_build
 
 # PyBuilder
 .pybuilder/
@@ -156,5 +156,4 @@ cython_debug/
 # End of https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks
 
 # Other items not to include for RISC-V usage
-docs/conf.py
-docs/json/
+docs/

docs/Makefile → Makefile

@@ -6,7 +6,7 @@
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = source
-BUILDDIR      = build
+BUILDDIR      = docs
 
 # Put it first so that "make" without argument is like "make help".
 help:

README.md

@@ -1,16 +1,21 @@
-# Template for RISC-V Markdown Docs published via the Read the Docs
+# RISC-V Ecosystem Lab Partners Documentation Project
 
-This GitHub template is based on the Read the Docs tutorial
-here:
+The documentation in this repo is based on the [riscv-admin/template-docs-rtd](https://github.com/riscv-admin/template-docs-rtd/)
+project.  It supports building documents with Sphinx in MD and RST, and then publishing to GitHub pages.
 
-https://docs.readthedocs.io/en/stable/tutorial/
+To contribute to this project, join the [RISC-V Ecosystem Lab Partners](https://lists.riscv.org/g/lab-partners)
+in the RISC-V Portal.
 
-The base tutorial is modified to remove python source code
-and assume the documentation is built in markdown (MD).
+The projects currently being developed are:
+
+1. Becoming an Ecosystem Lab Partner
+2. Hosting CI for a community
+
+The current published pages can be found at [https://riscv-admin.github.io/labs-doc/](https://riscv-admin.github.io/labs-doc/).
 
 The build process remains as Sphinx and template remains Read the Docs.
 
-Type `make html` in the `build` directory to build the document in `build/html/`.
+Type `make html` in the top directory to build the document in `docs/html/`.
 
 For more information on using Markdown, see the
 [MyST Project documetation](https://myst-parser.readthedocs.io/en/latest/index.html)

source/becoming_lab_partner.md

@@ -0,0 +1,3 @@
+# Becoming an RISC-V Ecosystem Labs Partner
+
+Yada yada...

source/ci_hosting.md

@@ -0,0 +1,3 @@
+# Hosting a Continuous Integration (CI) Project at a Lab
+
+Good details to come...

docs/source/conf.py → source/conf.py

@@ -2,7 +2,7 @@
 
 # -- Project information
 
-project = '<RISC-V Docs Template>'
+project = 'RISC-V Labs Documentation>'
 copyright = '2024, RISC-V International'
 author = 'RISC-V International'
 release = '0.1'

source/index.rst

@@ -0,0 +1,14 @@
+
+==========================================
+RISC-V Labs Best Practices Documentation
+==========================================
+
+TBD overview...
+
+Documents
+
+.. toctree::
+   :maxdepth: 2
+
+   becoming_lab_partner
+   ci_hosting