Skip to content

Commit

Permalink
Bugfix docs build process
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewcarbone committed Nov 6, 2024
1 parent 6ff650b commit b626c0c
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 55 deletions.
2 changes: 0 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@
#
import sys

print(sys.path)

project = "Lightshow"
copyright = "2024, Broohaven National Laboratory"
author = "Broohaven National Laboratory"
Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,6 @@ doc = [
"ipython",
"matplotlib",
"myst-parser",
"sphinx-doc"
]
build = [
"flit~=3.7",
Expand Down
3 changes: 0 additions & 3 deletions scripts/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,3 @@ Building
--------
We provide two self-contained scripts for building the Lightshow source and docs. These scripts are `build_project.sh` and `build_docs.sh`, respectively.

Versioning
----------
The version of Lightshow is controlled in a completely automatic fashion during CI execution. It works using the script `update_version.sh`. Specifically: TODO
28 changes: 14 additions & 14 deletions scripts/build_docs.sh
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
#!/bin/bash

build_docs () {
build_docs() {

if [[ "${GITHUB_ACTION_IS_RUNNING}" = 1 ]]; then
bash scripts/install.sh doc
fi
if [[ "${GITHUB_ACTION_IS_RUNNING}" = 1 ]]; then
bash scripts/install.sh doc
fi

make -C docs/ html
make -C docs/ html

# Helper when running on local. If not running in a GitHub Actions
# environment, this will attempt to open index.html with the users'
# default program
if [[ -z "${GITHUB_ACTION_IS_RUNNING}" ]]; then
open docs/build/html/index.html
fi

# Helper when running on local. If not running in a GitHub Actions
# environment, this will attempt to open index.html with the users'
# default program
if [[ -z "${GITHUB_ACTION_IS_RUNNING}" ]]; then
open docs/build/html/index.html
fi

}

pip install toml
bash scripts/install.sh
bash scripts/install.sh doc
bash scripts/update_version.sh set
echo "__version__ = '$(dunamai from any --style=pep440 --no-metadata)'" >lightshow/_version.py
build_docs
bash scripts/update_version.sh reset
git checkout lightshow/_version.py
35 changes: 0 additions & 35 deletions scripts/update_version.sh

This file was deleted.

0 comments on commit b626c0c

Please sign in to comment.