Skip to content

Commit ce17f66

Browse files
frayafraya
authored
Merge pull request #3 from fraya/main
Build package list from GH Actions
2 parents 87886ef + 1c93d34 commit ce17f66

File tree

11 files changed

+195
-384
lines changed

11 files changed

+195
-384
lines changed

‎.github/dependabot.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "github-actions" # See documentation for possible values
9+
directory: "/" # Location of package manifests
10+
schedule:
11+
interval: "weekly"

‎.github/workflows/build-website.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Build website
2+
3+
on:
4+
push:
5+
# all branches
6+
pull_request:
7+
8+
# This enables the Run Workflow button on the Actions tab.
9+
workflow_dispatch:
10+
11+
# https://github.com/JamesIves/github-pages-deploy-action#readme
12+
permissions:
13+
contents: write
14+
15+
# Set DYLAN environment variable to GITHUB_WORKSPACE so packages are
16+
# installed in ../../_packages relative to documentation's Makefile
17+
env:
18+
DYLAN: ${{ github.workspace }}
19+
20+
jobs:
21+
22+
build-and-deploy:
23+
runs-on: ubuntu-latest
24+
steps:
25+
26+
- name: Checkout code
27+
uses: actions/checkout@v4
28+
29+
- name: Check links
30+
uses: addnab/docker-run-action@v3
31+
with:
32+
image: ghcr.io/fraya/dylan-docs
33+
options: -v ${{ github.workspace }}/docs:/docs
34+
run: make linkcheck
35+
36+
- name: Build docs with Furo theme
37+
uses: addnab/docker-run-action@v3
38+
with:
39+
image: ghcr.io/fraya/dylan-docs
40+
options: -v ${{ github.workspace }}/docs:/docs
41+
run: make html
42+
43+
- name: Upload html artifact
44+
uses: actions/upload-artifact@v4
45+
with:
46+
name: dylan-lang-github-io-html
47+
path: docs/build/html/
48+
49+
- name: Bypassing Jekyll on GH Pages
50+
run: sudo touch docs/build/html/.nojekyll
51+
52+
- name: Deploy docs to GH pages
53+
uses: JamesIves/github-pages-deploy-action@v4
54+
with:
55+
folder: docs/build/html

‎.gitignore‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# backup files
2+
*~
3+
*.bak
4+
.DS_Store
5+
6+
# project file
7+
*.hdp
8+
9+
# documentation build directory
10+
build/
11+
12+
# compiler build directory
13+
_build/
14+
15+
# dylan tool package cache
16+
_packages/
17+
18+
# package registry folder
19+
registry/

‎README.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ displays documentation generated for Dylan-related GitHub repositories. For
66
released versions of the documentation, with a full search index, see
77
https://opendylan.org instead.
88

9-
Deploying this doc is a manual process for now. Simply edit :file:`index.rst`,
10-
run ``rst2html.py index.rst > index.html`` and make a pull request.
9+
Deploying this doc is a manual process for now. Simply edit
10+
`<docs/source/index.rst>`_ and make a pull request.

‎docs/Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/make.bat‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
%SPHINXBUILD% >NUL 2>NUL
14+
if errorlevel 9009 (
15+
echo.
16+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
17+
echo.installed, then set the SPHINXBUILD environment variable to point
18+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
19+
echo.may add the Sphinx directory to PATH.
20+
echo.
21+
echo.If you don't have Sphinx installed, grab it from
22+
echo.https://www.sphinx-doc.org/
23+
exit /b 1
24+
)
25+
26+
if "%1" == "" goto help
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/source/_static/images/opendylan-dark.png‎

36.9 KB
Loading

‎docs/source/_static/images/opendylan-light.png‎

35.4 KB
Loading

‎docs/source/conf.py‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# For the full list of built-in configuration values, see the documentation:
4+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
5+
6+
# -- Project information -----------------------------------------------------
7+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8+
9+
project = 'dylan-lang.github.io'
10+
copyright = '2024, Dylan Hackers'
11+
author = 'Dylan Hackers'
12+
release = '0.0.1'
13+
14+
# -- General configuration ---------------------------------------------------
15+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
16+
17+
extensions = []
18+
19+
templates_path = ['_templates']
20+
exclude_patterns = []
21+
22+
23+
24+
# -- Options for HTML output -------------------------------------------------
25+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
26+
27+
html_theme = 'furo'
28+
29+
html_static_path = ['_static']
30+
31+
# Configure logo
32+
html_theme_options = {
33+
"sidebar_hide_name": True,
34+
"light-logo": "images/opendylan-light.png",
35+
"dark-logo": "images/opendylan-dark.png",
36+
}
37+
38+
# Ignore certification verification
39+
tls_verify = False

index.rst renamed to docs/source/index.rst

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,27 @@
1+
.. dylan-lang.github.io documentation master file, created by
2+
sphinx-quickstart on Fri Apr 5 12:31:21 2024.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
16
Dylan Package Docs
27
==================
38

9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
413
This page is a (manually curated) index of Dylan package documentation, for all
514
Dylan repositories that are deployed via GitHub Actions to
6-
dylan-lang.github.io.
15+
`dylan-lang.github.io <https://dylan-lang.github.io>`_
716

817
If you don't see the package you want here, try accessing it directly at
9-
https://dylan-lang.github.io/your-package/ or search for it on `opendylan.org
18+
https://dylan-lang.github.io/``your-package`` or search for it on `opendylan.org
1019
<https://opendylan.org>`_ and `file a request
1120
<https://github.com/dylan-lang/dylan-lang.github.io/issues>`_ for it to be
1221
listed here.
1322

23+
Packages
24+
--------
25+
1426
* `binary-data <https://dylan-lang.github.io/binary-data/>`_
15-
* `dylan-tool <https://dylan-lang.github.io/dylan-tool/>`_
1627
* `testworks <https://dylan-lang.github.io/testworks/>`_

0 commit comments

Comments
 (0)