Skip to content

Commit

Permalink
Documentation update: changed from static HTML to sphinx documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
AntoineBrunet authored and mshumko committed May 16, 2024
1 parent 85c9ca1 commit 921b949
Show file tree
Hide file tree
Showing 41 changed files with 2,722 additions and 6,863 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: documentation

on: [push, pull_request, workflow_dispatch]

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
pip install sphinx pydata-sphinx-theme
- name: Build sphinx documentation
run: |
sphinx-build docs/source _build
- uses: actions/upload-pages-artifact@v3
with:
path: _build
deploy:
needs: build
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/deploy-pages@v4
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
build
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -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)
Binary file removed docs/frames/LOGO-COSPAR (new version).gif
Binary file not shown.
Binary file removed docs/frames/Lm_conventions.png
Binary file not shown.
Binary file removed docs/frames/Lstar_conventions.png
Binary file not shown.
Binary file removed docs/frames/Thumbs.db
Binary file not shown.
Loading

0 comments on commit 921b949

Please sign in to comment.