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

Fix #13288: Convert docs to mkdocs #13872

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,4 @@ Thumbs.db
tmp/*
venv
tests/unit/dist/
site/
1 change: 0 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,6 @@ RUN apt-install make sqlite3
COPY docker/bin/ssllabs-scan /usr/local/bin/ssllabs-scan
COPY requirements/* ./requirements/
RUN pip install --require-hashes --no-cache-dir -r requirements/dev.txt
RUN pip install --require-hashes --no-cache-dir -r requirements/docs.txt
COPY ./setup.cfg ./
COPY ./pyproject.toml ./
COPY ./.coveragerc ./
Expand Down
9 changes: 4 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,8 @@ help:
@echo " test - run tests against local files"
@echo " test-image - run tests against files in docker image"
@echo " test-cdn - run CDN tests against TEST_DOMAIN"
@echo " docs - generate Sphinx HTML documentation with server and live reload using Docker"
@echo " livedocs - generate Sphinx HTML documentation with server and live reload"
@echo " build-docs - generate Sphinx HTML documentation using Docker"
@echo " docs - generate mkdocs HTML documentation with server and live reload using Docker"
@echo " build-docs - generate mkdocs HTML documentation"
@echo " build-ci - build docker images for use in our CI pipeline"
@echo " test-ci - run tests against files in docker image built by CI"
@echo " compile-requirements - update Python requirements files using pip-compile"
Expand Down Expand Up @@ -129,10 +128,10 @@ docs: .docker-build-pull
${DC} up docs

build-docs: .docker-build-pull
${DC} run app make -C docs/ clean html
${DC} run app mkdocs build -d "docs/_build"

livedocs:
${MAKE} -C docs/ clean livehtml
mkdocs serve

test_infra/fixtures/tls.json:
${DOCKER} run -it --rm jumanjiman/ssllabs-scan:latest --quiet https://${TEST_DOMAIN}/en-US/ > "test_infra/fixtures/tls.json"
Expand Down
1 change: 0 additions & 1 deletion bin/compile-requirements.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,3 @@ pip install pip-tools==6.13.0

pip-compile --generate-hashes -r requirements/prod.in --resolver=backtracking --rebuild
pip-compile --generate-hashes -r requirements/dev.in --resolver=backtracking --rebuild
pip-compile --generate-hashes -r requirements/docs.in --resolver=backtracking --rebuild
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ services:
docs:
image: mozmeao/bedrock_test:${GIT_COMMIT:-latest}
platform: linux/amd64
command: sphinx-autobuild "docs" "docs/_build/html" --host 0.0.0.0 --port 8100
command: mkdocs serve -d "docs/_build" -a "0.0.0.0:8100"
ports:
- "8100:8100"
volumes:
Expand Down
142 changes: 0 additions & 142 deletions docs/Makefile

This file was deleted.

Empty file removed docs/_static/.gitkeep
Empty file.
Empty file removed docs/_templates/.gitkeep
Empty file.
53 changes: 0 additions & 53 deletions docs/_templates/footer.html

This file was deleted.

Loading
Loading