Skip to content
Merged
Show file tree
Hide file tree
Changes from 32 commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
35fb31e
Add documentation for how to administer Read the Docs for documentation
stevepiercy May 15, 2024
d69b493
Remove subprojects mention
stevepiercy May 16, 2024
a71e224
Remove Netlify configuration
stevepiercy May 16, 2024
cc70b0e
Merge branch '6.0' into pull-request-preview
stevepiercy May 16, 2024
03335af
Update requirements files
stevepiercy May 16, 2024
25a9e76
Remove netlify.toml
stevepiercy May 16, 2024
79e77be
Add RTD configuration
stevepiercy May 16, 2024
cb5eb31
Update conf.py for new theme
stevepiercy May 16, 2024
9607018
Add configuration for pull request previews on RTD
stevepiercy May 16, 2024
c23aa55
Try using deps to pull in submodules and create symlinks
stevepiercy May 16, 2024
6e48d39
RTD cannot run multiple make targets
stevepiercy May 16, 2024
f4d0076
Remove obsolete Sphinx template `_templates/sections/header-article.h…
stevepiercy May 16, 2024
36c78cb
Purge Netlify
stevepiercy May 17, 2024
4344e0e
Attempt to make plone.api importable to Sphinx
stevepiercy May 17, 2024
bef89c4
Attempt to make plone.api importable to Sphinx
stevepiercy May 17, 2024
dbe975a
Attempt to make plone.api importable to Sphinx
stevepiercy May 17, 2024
37a8ed4
Attempt to make plone.api importable to Sphinx
stevepiercy May 17, 2024
14bb19e
Attempt to make plone.api importable to Sphinx
stevepiercy May 17, 2024
5aceb91
Attempt to make plone.api importable to Sphinx
stevepiercy May 17, 2024
f28a966
Attempt to make plone.api importable to Sphinx
stevepiercy May 17, 2024
77a4299
Attempt to make plone.api importable to Sphinx
stevepiercy May 17, 2024
103ab2e
Attempt to make plone.api importable to Sphinx by bypassing Makefile
stevepiercy May 17, 2024
be920d4
Attempt to make plone.api importable to Sphinx by bypassing Makefile
stevepiercy May 17, 2024
bd5c377
Attempt to make plone.api importable to Sphinx by using its system Py…
stevepiercy May 17, 2024
0c67dd2
Attempt to make plone.api importable to Sphinx by using its system Py…
stevepiercy May 17, 2024
0a4968c
Fix link references
stevepiercy May 17, 2024
d5d6974
Relocate static files
stevepiercy May 18, 2024
35ab6fb
Purge Netlify
stevepiercy May 18, 2024
d99838e
Clean up `conf.py`
stevepiercy May 18, 2024
ada6b81
Fix link
stevepiercy May 19, 2024
097546f
Revert "Try using deps to pull in submodules and create symlinks"
stevepiercy May 20, 2024
9dc849d
Merge branch '6.0' into pull-request-preview
stevepiercy May 20, 2024
35372cf
Rename headings and improve flow
stevepiercy May 21, 2024
df9a0ee
Rewrite search engine indexing section
stevepiercy May 21, 2024
06ffcc1
Merge branch '6.0' into pull-request-preview
stevepiercy May 21, 2024
84c0ff0
Update configuration to build only on changes to docs files
stevepiercy May 21, 2024
ca19f1c
Use commands instead
stevepiercy May 21, 2024
28b9df9
Merge branch '6.0' into pull-request-preview
stevepiercy May 21, 2024
e566e06
Merge branch '6.0' into pull-request-preview
stevepiercy Jun 20, 2024
0d89f9d
Merge branch '6.0' into pull-request-preview
stevepiercy Nov 14, 2024
487e0c1
- Sort items in .gitignore
stevepiercy Nov 14, 2024
d9d66e6
- Remove obsolete custom.css file
stevepiercy Nov 14, 2024
37d86f3
Update comments in linkcheckignore
stevepiercy Nov 14, 2024
d54377f
plone.api must be installed to build its API docs. Remove symlinks in…
stevepiercy Nov 15, 2024
9aef4fc
Tidy up conf.py
stevepiercy Nov 15, 2024
25e4983
This file's content was migrated elsewhere
stevepiercy Nov 15, 2024
bc72bcd
Disable Edit this page, and add comments explaining that it does not …
stevepiercy Nov 17, 2024
3a417d5
Update documentation for build pull request previews.
stevepiercy Nov 17, 2024
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
22 changes: 22 additions & 0 deletions .github/workflows/rtd-pr-preview.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# .github/workflows/rtd-pr-preview.yml
name: readthedocs/actions
on:
pull_request_target:
types:
- opened
# Execute this action only on PRs that touch
# documentation files.
# paths:
# - "docs/**"

permissions:
pull-requests: write

jobs:
documentation-links:
runs-on: ubuntu-latest
steps:
- uses: readthedocs/actions/preview@v1
with:
project-slug: "plone6"
single-version: "true"
24 changes: 24 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"
# nodejs: "19"
commands:
- make rtd-pr-preview

# Build documentation in the "docs/" directory with Sphinx
#sphinx:
# configuration: docs/conf.py

# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
#python:
# install:
# - requirements: docs/requirements.txt
13 changes: 6 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -224,18 +224,17 @@ livehtml: deps ## Rebuild Sphinx documentation on changes, with live-reload in
--port 8050 \
-b html . "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)

.PHONY: netlify
netlify:
.PHONY: rtd-pr-preview
rtd-pr-preview: ## Build pull request preview on Read the Docs
pip install -r requirements-initial.txt
pip install -r requirements.txt
pip install -r requirements-netlify.txt
git submodule init; \
git submodule update; \
pip install -e submodules/plone.api[test]; \
git submodule init
git submodule update
pip install -e submodules/plone.api[test]
ln -s ../submodules/volto/docs/source ./docs/volto
ln -s ../submodules/plone.restapi ./docs/plone.restapi
ln -s ../submodules/plone.api/docs ./docs/plone.api
cd $(DOCS_DIR) && sphinx-build -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html && cp ./netlify_robots.txt $(BUILDDIR)/html/robots.txt
cd $(DOCS_DIR) && sphinx-build -b html $(ALLSPHINXOPTS) ${READTHEDOCS_OUTPUT}/html/

.PHONY: storybook
storybook:
Expand Down
File renamed without changes.
Empty file.
35 changes: 0 additions & 35 deletions docs/_templates/sections/header-article.html

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ The standard theme in Classic UI was updated to Bootstrap 5, CSS variables, and
If you have a theme that builds on Barceloneta, you most likely need various changes.

It may be best to start with a fresh theme, and try to keep the changes minimal.
The training documentation lists {doc}`three possible theming strategies <theming_plone_5/index>`:
The training documentation lists {doc}`three possible theming strategies <training-2022:theming_plone_5/index>`:

- Create a theme based on Barceloneta.
- Create a theme from scratch.
Expand Down
Loading