From f0a5e6a3916b1d79be29263391bade07235d7586 Mon Sep 17 00:00:00 2001 From: nekiwo Date: Tue, 6 Aug 2024 16:11:51 -0500 Subject: [PATCH] test commit --- .github/workflows/sphinx.yml | 27 ++++++++++++++++ Makefile | 20 ++++++++++++ make.bat | 35 +++++++++++++++++++++ source/Resources/index.md | 3 ++ source/_ext/makedomain.py | 21 +++++++++++++ source/conf.py | 61 ++++++++++++++++++++++++++++++++++++ source/index.md | 13 ++++++++ 7 files changed, 180 insertions(+) create mode 100644 .github/workflows/sphinx.yml create mode 100644 Makefile create mode 100644 make.bat create mode 100644 source/Resources/index.md create mode 100644 source/_ext/makedomain.py create mode 100644 source/conf.py create mode 100644 source/index.md diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml new file mode 100644 index 0000000..be5d2e4 --- /dev/null +++ b/.github/workflows/sphinx.yml @@ -0,0 +1,27 @@ +name: "Sphinx: Render docs" + +on: push + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - uses: actions/checkout@v4 + - name: Build HTML + uses: ammaraskar/sphinx-action@main + with: + pre-build-command: "pip3 install --user --ignore-installed sphinxcontrib-domaintools myst-parser furo sphinx>=6.0 sphinx_design sphinx-copybutton" + docs-folder: . + - 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/main' + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: build/html \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..269cadc --- /dev/null +++ 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) \ No newline at end of file diff --git a/make.bat b/make.bat new file mode 100644 index 0000000..dafd057 --- /dev/null +++ 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 \ No newline at end of file diff --git a/source/Resources/index.md b/source/Resources/index.md new file mode 100644 index 0000000..e076d09 --- /dev/null +++ b/source/Resources/index.md @@ -0,0 +1,3 @@ +# Resources +## Documentation and other websites +The [official WPILib documentation](https://docs.wpilib.org/en/stable/) has the most amount of content regarding FRC programming. \ No newline at end of file diff --git a/source/_ext/makedomain.py b/source/_ext/makedomain.py new file mode 100644 index 0000000..81e8849 --- /dev/null +++ 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', + } \ No newline at end of file diff --git a/source/conf.py b/source/conf.py new file mode 100644 index 0000000..e30381e --- /dev/null +++ b/source/conf.py @@ -0,0 +1,61 @@ +# 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 = 'GNUstep Tutorials' +copyright = '2024, GNUstep contributors' +author = 'GNUstep contributors' + +# The full version, including alpha/beta/rc tags +release = '2024' + + +# -- 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' + +# 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'] \ No newline at end of file diff --git a/source/index.md b/source/index.md new file mode 100644 index 0000000..5ff98a3 --- /dev/null +++ b/source/index.md @@ -0,0 +1,13 @@ +# GNUstep Tutorials + +```{toctree} +--- +caption: Contents +titlesonly: true +--- +ObjectiveCIntro/index.md +AppsWithGorm/index.md +AppsWithCodeOnly/index.md +AppsWithRenaissance/index.md +CommandLineTools/index.md +``` \ No newline at end of file