Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to Plone Sphinx Theme for documentation, include changes to http-examples to build docs preview #1815

Merged
merged 11 commits into from
Sep 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ jobs:
- run: pip install virtualenv
- run: pip install wheel
- name: pip install
run: pip install -r requirements-${{ matrix.plone-version }}.txt -r requirements-docs.txt
run: pip install -r requirements-${{ matrix.plone-version }}.txt

# buildout
- name: buildout
Expand All @@ -60,7 +60,7 @@ jobs:

# build sphinx
- name: sphinx
run: if [ "${{ matrix.plone-version }}" == "6.0" ] && [ ${{ matrix.python-version }} == '3.12' ]; then make docs-html; fi
run: if [ "${{ matrix.plone-version }}" == "6.0" ] && [ ${{ matrix.python-version }} == '3.12' ]; then pip install -r requirements-docs.txt && make docs-html; fi
stevepiercy marked this conversation as resolved.
Show resolved Hide resolved

# test
- name: test
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ build:
# If there are no changes (git diff exits with 0) we force the command to return with 183.
# This is a special exit code on Read the Docs that will cancel the build immediately.
- |
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/ .readthedocs.yaml requirements-docs.txt requirements.txt;
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/ src/plone/restapi/tests/http-examples/ .readthedocs.yaml requirements-docs.txt requirements.txt;
then
exit 183;
fi
Expand Down
7 changes: 5 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,13 @@ black: ## Black
zpretty: ## zpretty
if [ -f "bin/zpretty" ]; then zpretty -i ./**/*.zcml; fi

.PHONY: python-clean
python-clean: ## Clean Python virtual environment
rm -rf bin include lib

.PHONY: docs-clean
docs-clean: ## Clean current and legacy docs build directories, and Python virtual environment
docs-clean: ## Clean current and legacy docs build directories
cd $(DOCS_DIR) && rm -rf $(BUILDDIR)/
rm -rf bin include lib
rm -rf docs/build

.PHONY: docs-html
Expand Down
353 changes: 0 additions & 353 deletions docs/source/_static/custom.css

This file was deleted.

Loading
Loading