Skip to content

Commit d8ab9bc

Browse files
EliEli
authored andcommitted
Eliminate README.md, which was a second source of doc on top of existing.
README.md ignored the existing documentation system in sphix. Folded in most of the important stuff from the .md into the rst docs. Attempted revision of documentation building system by eliminating heavyweight imports from conda.
1 parent 2ed1ed8 commit d8ab9bc

3 files changed

Lines changed: 25 additions & 438 deletions

File tree

.github/workflows/build_sphinx.yml

Lines changed: 7 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -18,48 +18,30 @@ jobs:
1818
build:
1919
runs-on: ubuntu-latest
2020
steps:
21-
- uses: actions/checkout@v2
21+
- uses: actions/checkout@v4
2222
with:
2323
fetch-depth: 0
2424
- name: Set up Python 3.10
25-
uses: actions/setup-python@v2
25+
uses: actions/setup-python@v5
2626
with:
2727
python-version: "3.10"
28-
- name: Add conda to system path
28+
- name: Install pandoc
29+
run: sudo apt-get install -y pandoc
30+
- name: Install Python dependencies
2931
run: |
30-
echo $CONDA/bin >> $GITHUB_PATH
31-
- name: Conda build env for docs
32-
shell: bash
33-
run: |
34-
conda env create --name dms_datastore -f environment.yml
35-
source $CONDA/etc/profile.d/conda.sh
36-
conda activate dms_datastore
3732
python -m pip install --upgrade pip
38-
pip install -r docsrc/requirements.txt
33+
pip install pandas numpy pyyaml click requests httpx scipy matplotlib xarray tqdm openpyxl lxml
34+
pip install -r docsrc/requirements.txt
3935
pip install --no-deps -e .
40-
ghp-import -h
4136
- name: Build HTML
42-
shell: bash
4337
run: |
44-
source $CONDA/etc/profile.d/conda.sh
45-
conda activate dms_datastore
4638
cd docsrc/
47-
#sphinx-apidoc --force -o . ../dms_datastore
4839
make clean
4940
make html
50-
5141
- name: Run ghp-import
52-
shell: bash
5342
env:
5443
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5544
run: |
56-
source $CONDA/etc/profile.d/conda.sh
57-
conda activate dms_datastore
58-
ghp-import -h
5945
git config http.postBuffer 157286400
60-
git pull
61-
62-
tree -L 3 -a
63-
6446
ghp-import -n -p -f ./docs/html
6547

0 commit comments

Comments
 (0)