Skip to content

Commit

Permalink
Add some workflow nonsense
Browse files Browse the repository at this point in the history
  • Loading branch information
bgranzow committed Oct 26, 2023
1 parent d35ae9e commit 3a9943d
Show file tree
Hide file tree
Showing 6 changed files with 52 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: doc

on:
push:
branches: ['main']
paths:
- 'doc/**'
- '.github/workflows/**'

permissions:
contents: write

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme myst_parser
- name: Sphinx build
run: |
sphinx-build doc _build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true
Empty file added doc/_build/.gitkeep
Empty file.
Empty file added doc/_static/.gitkeep
Empty file.
Empty file added doc/_templates/.gitkeep
Empty file.
10 changes: 10 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
project = 'Calibr8'
copyright = 'Sandia National Laboratories'
author = 'Sandia National Laboratories'
release = '1.0.0'
extensions = [
]
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
11 changes: 11 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _index:

=======
Welcome
=======

Welcome to the Calibr8 documentation.

.. toctree::
:maxdepth: 1
:caption: Table of Contents:

0 comments on commit 3a9943d

Please sign in to comment.