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

Documentation Refactor #295

Merged
merged 7 commits into from
Dec 12, 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
10 changes: 1 addition & 9 deletions .github/workflows/testing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,21 +92,13 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
python-version: '3.12'

- name: Install nox
run: python -m pip install --progress-bar off --upgrade nox

- name: Install graphviz
run: sudo apt install graphviz

- name: Install pandoc
run: |
PANDOC_VERSION="3.1.11.1"
wget -q https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/pandoc-${PANDOC_VERSION}-1-amd64.deb
sudo dpkg -i pandoc-${PANDOC_VERSION}-1-amd64.deb
rm pandoc-${PANDOC_VERSION}-1-amd64.deb
pandoc --version

- name: Build documentation
run: nox -s docs
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ instance/
.scrapy

# Sphinx documentation
docs/_build/
docs/generated
docs/sg_execution_times.rst
docs/_build
docs/api

# PyBuilder
Expand Down
20 changes: 3 additions & 17 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ repos:
- id: check-github-workflows

- repo: https://github.com/sirosen/texthooks
rev: 0.6.7
rev: 0.6.8
hooks:
- id: fix-smartquotes
- id: fix-spaces
Expand All @@ -40,6 +40,7 @@ repos:
hooks:
- id: remove-crlf
name: remove CRLF line endings

- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
rev: v2.14.0
hooks:
Expand All @@ -48,12 +49,6 @@ repos:
- id: pretty-format-yaml
args: [--autofix]

- repo: https://github.com/MarcoGorelli/absolufy-imports
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replaced by ruff

rev: v0.3.1
hooks:
- id: absolufy-imports
name: Use absolute rather than relative imports

- repo: https://github.com/pre-commit/pygrep-hooks
rev: v1.10.0
hooks:
Expand All @@ -72,7 +67,7 @@ repos:
exclude: .*\.fits

- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.8.1
rev: v0.8.3
hooks:
- id: ruff
name: ruff
Expand All @@ -87,12 +82,3 @@ repos:
name: autoformat code blocks in docs
additional_dependencies:
- black

- repo: https://github.com/nbQA-dev/nbQA
rev: 1.9.1
hooks:
- id: nbqa-check-ast
name: validate Python notebooks
- id: nbqa-black
additional_dependencies:
- black
3 changes: 3 additions & 0 deletions .ruff.toml
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,6 @@ ignore = [
"E402", # Module imports not at top of file
"INP001", # Implicit-namespace-package. The examples are not a package.
]
"examples/*" = [
"INP001", # Implicit-namespace-package. The examples are not a package.
]
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
BSD 2-Clause License

Copyright (c) 2021–2023, XRTpy contributors
Copyright (c) 2021-2024, XRTpy contributors
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
1 change: 0 additions & 1 deletion changelog/139.removal.rst

This file was deleted.

3 changes: 0 additions & 3 deletions changelog/187.doc.rst

This file was deleted.

Empty file removed changelog/README.md
Empty file.
50 changes: 0 additions & 50 deletions docs/CODE_OF_CONDUCT.rst

This file was deleted.

9 changes: 9 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,15 @@ help:

.PHONY: help Makefile

html-noplot:
@$(SPHINXBUILD) -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

clean:
rm -rf $(BUILDDIR)
rm -rf ./generated

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
Expand Down
144 changes: 0 additions & 144 deletions docs/_static/css/admonition_color_contrast.css

This file was deleted.

Loading
Loading