Skip to content
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
3 changes: 1 addition & 2 deletions bin/dev-docs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#!/bin/bash
set -ex

make -C docs/dev/ doctest SPHINXOPTS="-W"
make -C docs/dev/ html SPHINXOPTS="-W"
mkdocs build -f docs/mkdocs-dev-docs.yml --strict
6 changes: 3 additions & 3 deletions bin/rtd-docs
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ set -e
set -x

if [ "${READTHEDOCS_PROJECT}" = "warehouse" ]; then
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/dev requirements/docs-dev.txt .readthedocs.yaml; then
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/dev requirements/docs-dev.txt .readthedocs.yaml docs/mkdocs-dev-docs.yml; then
echo "Nothing relevant changed, skipping build..."
exit 183;
fi
pip install -r requirements/docs-dev.txt
asdf reshim
make -C docs/dev/ html
mkdir _readthedocs && mv docs/dev/_build/html _readthedocs/html
mkdocs build -f docs/mkdocs-dev-docs.yml
mkdir _readthedocs && mv docs/dev-site _readthedocs/html
fi

if [ "${READTHEDOCS_PROJECT}" = "docspypiorg" ]; then
Expand Down
4 changes: 3 additions & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -256,9 +256,11 @@ services:
context: .
target: docs
image: warehouse:docker-compose-docs
command: sphinx-autobuild --host 0.0.0.0 "docs/dev/" "docs/dev/_build"
command: mkdocs serve -a 0.0.0.0:8000 -f docs/mkdocs-dev-docs.yml
stop_signal: SIGINT
volumes:
- ./bin:/opt/warehouse/src/bin:z
- ./docs/mkdocs-dev-docs.yml:/opt/warehouse/src/docs/mkdocs-dev-docs.yml:z
- ./docs:/opt/warehouse/src/docs:z
ports:
- "10002:8000"
Expand Down
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
user-site
blog-site
dev-site
181 changes: 0 additions & 181 deletions docs/dev/Makefile

This file was deleted.

Binary file removed docs/dev/_static/check-lifecycle.png
Binary file not shown.
1 change: 0 additions & 1 deletion docs/dev/_static/css/extra.css

This file was deleted.

Binary file removed docs/dev/_static/verdict-lifecycle.png
Binary file not shown.
5 changes: 5 additions & 0 deletions docs/dev/api-reference/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# API reference

!!! note
All API documentation except for [XML-RPC](xml-rpc.md) has been moved to the
[user documentation site](https://docs.pypi.org/api/).
12 changes: 0 additions & 12 deletions docs/dev/api-reference/index.rst

This file was deleted.

Loading