Skip to content

Commit

Permalink
Drop insider doc dependencies (#115)
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonBoothroyd authored Oct 20, 2024
1 parent 7d9ef1a commit cc9c847
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
make lint
make test
make test-examples
make docs-build
make docs
# TODO: Remove this line once pydantic 1.0 support is dropped
mamba install --name smee --yes "pydantic <2"
Expand Down
6 changes: 0 additions & 6 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,6 @@ jobs:
fi
- name: Build and Deploy Documentation
env:
INSIDER_DOCS_TOKEN: ${{ secrets.INSIDER_DOCS_TOKEN }}
run: |
git config --global user.name 'GitHub Actions'
git config --global user.email 'actions@github.com'
Expand All @@ -45,8 +43,4 @@ jobs:
git pull origin gh-pages --allow-unrelated-histories
make env
sed -i 's/# extensions/extensions/' mkdocs.yml
make docs-insiders INSIDER_DOCS_TOKEN="${INSIDER_DOCS_TOKEN}"
make docs-deploy VERSION="$VERSION"
8 changes: 2 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ CONDA_ENV_RUN := conda run --no-capture-output --name $(PACKAGE_NAME)
EXAMPLES_SKIP := examples/md-simulations.ipynb
EXAMPLES := $(filter-out $(EXAMPLES_SKIP), $(wildcard examples/*.ipynb))

.PHONY: env lint format test test-examples docs-build docs-deploy docs-insiders
.PHONY: env lint format test test-examples docs docs-deploy

env:
mamba create --name $(PACKAGE_NAME)
Expand All @@ -28,15 +28,11 @@ test:
test-examples:
$(CONDA_ENV_RUN) jupyter nbconvert --to notebook --execute $(EXAMPLES)

docs-build:
docs:
$(CONDA_ENV_RUN) mkdocs build

docs-deploy:
ifndef VERSION
$(error VERSION is not set)
endif
$(CONDA_ENV_RUN) mike deploy --push --update-aliases $(VERSION)

docs-insiders:
$(CONDA_ENV_RUN) pip install git+https://$(INSIDER_DOCS_TOKEN)@github.com/SimonBoothroyd/mkdocstrings-python.git \
git+https://$(INSIDER_DOCS_TOKEN)@github.com/SimonBoothroyd/griffe-pydantic.git
5 changes: 3 additions & 2 deletions devtools/envs/base.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,13 @@ dependencies:
- codecov

# Docs
- mkdocs <1.6
- mkdocs
- mkdocs-material
- mkdocs-gen-files
- mkdocs-literate-nav
- mkdocs-jupyter
- mkdocstrings
- mkdocstrings-python
- mkdocstrings-python >=1.10.8
- griffe-pydantic
- black
- mike
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ plugins:
import:
- http://docs.openmm.org/latest/api-python/objects.inv
options:
# extensions: [ griffe_pydantic ]
extensions: [ griffe_pydantic ]
docstring_options:
ignore_init_summary: true
returns_multiple_items: false
Expand Down

0 comments on commit cc9c847

Please sign in to comment.