Skip to content

Commit

Permalink
Drop empty sphinx docs (#3822)
Browse files Browse the repository at this point in the history
* Drop empty sphinx docs

* Drop other sphinx configs
  • Loading branch information
DeD1rk authored Nov 4, 2024
1 parent 11e00d7 commit 0efa7d8
Show file tree
Hide file tree
Showing 89 changed files with 395 additions and 3,956 deletions.
1 change: 0 additions & 1 deletion .codeclimate.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
version: "2"
exclude_patterns:
- "**/migrations/*.py"
- "docs/"
checks:
complex-logic:
config:
Expand Down
1 change: 0 additions & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ website/db.sqlite3

**/Dockerfile
**/README.md
docs

.git
.github
Expand Down
36 changes: 0 additions & 36 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -165,22 +165,6 @@ jobs:
run: poetry install
if: steps.cache.outputs.cache-hit != 'true'

- name: Run doctest
run: make doctest

- name: Run Sphinx
run: make docs

- name: Run API docs script
run: |
make apidocscheck
- name: Save documentation HTML
uses: actions/upload-artifact@v4
with:
name: docs-html
path: docs/_build

upload-coverage:
name: Deploy Coverage Report
runs-on: ubuntu-latest
Expand All @@ -200,23 +184,3 @@ jobs:
AWS_DEFAULT_REGION: eu-west-1
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

upload-docs:
name: Deploy Documentation
runs-on: ubuntu-latest
needs: [documentation-tests]
steps:
- uses: actions/download-artifact@v4
with:
name: docs-html
path: html

- name: Create URL safe version of GITHUB_REF
run: echo "GITHUB_REF_SLUG=$(echo \"${GITHUB_REF#refs/heads/}\" | iconv -t ascii//TRANSLIT | sed -E 's/[^a-zA-Z0-9]+/-/g' | sed -E 's/^-+|-+$//g' | tr A-Z a-z)" >> "${GITHUB_ENV}"

- name: Sync files to S3
run: aws s3 sync html "s3://thalia-documentation/${GITHUB_REF_SLUG}/"
env:
AWS_DEFAULT_REGION: eu-west-1
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
28 changes: 2 additions & 26 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -253,30 +253,6 @@ coverage: .coverage ## Generate a coverage report after running the tests
covhtml: .coverage ## Generate an HTML coverage report
poetry run coverage html --directory=covhtml --no-skip-covered --title="Coverage Report"

.make/docsdeps: .make .make/deps
poetry install $(POETRY_FLAGS) --with docs
@touch .make/docsdeps

.PHONY: apidocs
apidocs: ## Generate API docs
cd docs && poetry run sphinx-apidoc -M -f -o . ../website ../website/*/migrations ../website/*/tests* ../website/manage.py

.make/doctest: .make/docsdeps
cd docs && poetry run sphinx-build -M doctest . _build

.PHONY: doctest
doctest: .make/doctest ## Run doctests

# This could be a recipe which checks the modification date of input files, but
# that would be too complicated and this isn't run that often anyways.
.PHONY: docs
docs: ## Generate docs HTML files
cd docs && poetry run sphinx-build -M html . _build

.PHONY: apidocscheck
apidocscheck: apidocs # Check whether new apidocs are generated
@git diff --name-only | grep 'docs/' >/dev/null && (echo "WARNING: you have uncommitted apidocs changes"; exit 1) || exit 0

.PHONY: graphs
graphs: ## Generate model graphs
@echo "Generating full models graph"
Expand All @@ -303,7 +279,7 @@ lint: isortcheck blackcheck ruff ## Run all linters
test: check templatecheck migrationcheck tests ## Run every kind of test

.PHONY: ci
ci: isortcheck blackcheck ruff coverage doctest docs apidocscheck ## Do all the checks the GitHub Actions CI does
ci: isortcheck blackcheck ruff coverage ## Do all the checks the GitHub Actions CI does

# Sometimes you don't want make to do the whole modification time checking thing
# so this cleans up the whole repository and allows you to start over from
Expand All @@ -312,4 +288,4 @@ ci: isortcheck blackcheck ruff coverage doctest docs apidocscheck ## Do all the
.PHONY: clean
clean: ## Remove all generated files
rm -f .coverage website/db.sqlite3
rm -rf website/media website/static docs/_build .make
rm -rf website/media website/static .make
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,6 @@ apt-get install python3-dev build-essential libjpeg-dev zlib1g-dev libwebp-dev

For other operating systems, see the [Pillow Documentation](https://pillow.readthedocs.io/en/latest/installation.html).

On macOS you will also need to install `libmagic`, using the brew package manager by running `brew install libmagic`.

> **Contributing**:
> also see the [contributing guidelines](CONTRIBUTING.md) for more information on how to contribute to concrexit.
Expand Down
1 change: 0 additions & 1 deletion docs/.gitignore

This file was deleted.

16 changes: 0 additions & 16 deletions docs/activemembers.api.rst

This file was deleted.

34 changes: 0 additions & 34 deletions docs/activemembers.api.v1.rst

This file was deleted.

18 changes: 0 additions & 18 deletions docs/activemembers.api.v2.rst

This file was deleted.

106 changes: 0 additions & 106 deletions docs/activemembers.rst

This file was deleted.

16 changes: 0 additions & 16 deletions docs/announcements.api.rst

This file was deleted.

34 changes: 0 additions & 34 deletions docs/announcements.api.v1.rst

This file was deleted.

34 changes: 0 additions & 34 deletions docs/announcements.api.v2.rst

This file was deleted.

Loading

0 comments on commit 0efa7d8

Please sign in to comment.