sphinx-structured-toc 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. sphinx_structured_toc-0.1.0/.gitignore +90 -0
  2. sphinx_structured_toc-0.1.0/.pre-commit-config.yaml +26 -0
  3. sphinx_structured_toc-0.1.0/.readthedocs.yaml +25 -0
  4. sphinx_structured_toc-0.1.0/LICENSE +674 -0
  5. sphinx_structured_toc-0.1.0/Makefile +45 -0
  6. sphinx_structured_toc-0.1.0/PKG-INFO +706 -0
  7. sphinx_structured_toc-0.1.0/README.rst +8 -0
  8. sphinx_structured_toc-0.1.0/common.mk +265 -0
  9. sphinx_structured_toc-0.1.0/docs/Makefile +23 -0
  10. sphinx_structured_toc-0.1.0/docs/approaches.rst +52 -0
  11. sphinx_structured_toc-0.1.0/docs/conf.py +17 -0
  12. sphinx_structured_toc-0.1.0/docs/demo-targets/custom-fields-how-to.rst +6 -0
  13. sphinx_structured_toc-0.1.0/docs/demo-targets/field-types-reference.rst +6 -0
  14. sphinx_structured_toc-0.1.0/docs/demo-targets/lookup-expressions-how-to.rst +6 -0
  15. sphinx_structured_toc-0.1.0/docs/demo-targets/model-reference.rst +6 -0
  16. sphinx_structured_toc-0.1.0/docs/demo-targets/queries-reference.rst +6 -0
  17. sphinx_structured_toc-0.1.0/docs/demo-targets/queryset-operations-how-to.rst +6 -0
  18. sphinx_structured_toc-0.1.0/docs/demo-targets/view-functions-introduction.rst +6 -0
  19. sphinx_structured_toc-0.1.0/docs/demo-targets/views-reference.rst +6 -0
  20. sphinx_structured_toc-0.1.0/docs/developer-reference.rst +20 -0
  21. sphinx_structured_toc-0.1.0/docs/index.rst +161 -0
  22. sphinx_structured_toc-0.1.0/docs/installation-and-usage.rst +128 -0
  23. sphinx_structured_toc-0.1.0/docs/make.bat +30 -0
  24. sphinx_structured_toc-0.1.0/docs/reference.rst +133 -0
  25. sphinx_structured_toc-0.1.0/pyproject.toml +259 -0
  26. sphinx_structured_toc-0.1.0/setup.cfg +4 -0
  27. sphinx_structured_toc-0.1.0/sphinx_structured_toc/__init__.py +83 -0
  28. sphinx_structured_toc-0.1.0/sphinx_structured_toc/_version.py +24 -0
  29. sphinx_structured_toc-0.1.0/sphinx_structured_toc/directives.py +173 -0
  30. sphinx_structured_toc-0.1.0/sphinx_structured_toc/domain-list.css +29 -0
  31. sphinx_structured_toc-0.1.0/sphinx_structured_toc/html.py +190 -0
  32. sphinx_structured_toc-0.1.0/sphinx_structured_toc/nodes.py +13 -0
  33. sphinx_structured_toc-0.1.0/sphinx_structured_toc/transforms.py +175 -0
  34. sphinx_structured_toc-0.1.0/sphinx_structured_toc.egg-info/PKG-INFO +706 -0
  35. sphinx_structured_toc-0.1.0/sphinx_structured_toc.egg-info/SOURCES.txt +55 -0
  36. sphinx_structured_toc-0.1.0/sphinx_structured_toc.egg-info/dependency_links.txt +1 -0
  37. sphinx_structured_toc-0.1.0/sphinx_structured_toc.egg-info/requires.txt +5 -0
  38. sphinx_structured_toc-0.1.0/sphinx_structured_toc.egg-info/scm_file_list.json +51 -0
  39. sphinx_structured_toc-0.1.0/sphinx_structured_toc.egg-info/scm_version.json +8 -0
  40. sphinx_structured_toc-0.1.0/sphinx_structured_toc.egg-info/top_level.txt +1 -0
  41. sphinx_structured_toc-0.1.0/tests/__init__.py +0 -0
  42. sphinx_structured_toc-0.1.0/tests/conftest.py +79 -0
  43. sphinx_structured_toc-0.1.0/tests/integration/__init__.py +0 -0
  44. sphinx_structured_toc-0.1.0/tests/integration/example/__init__.py +0 -0
  45. sphinx_structured_toc-0.1.0/tests/integration/example/conf.py +15 -0
  46. sphinx_structured_toc-0.1.0/tests/integration/example/index.rst +5 -0
  47. sphinx_structured_toc-0.1.0/tests/integration/test_docs_build.py +24 -0
  48. sphinx_structured_toc-0.1.0/tests/unit/__init__.py +0 -0
  49. sphinx_structured_toc-0.1.0/tests/unit/test_ambiguity.py +203 -0
  50. sphinx_structured_toc-0.1.0/tests/unit/test_directives.py +196 -0
  51. sphinx_structured_toc-0.1.0/tests/unit/test_html.py +304 -0
  52. sphinx_structured_toc-0.1.0/tests/unit/test_ids.py +230 -0
  53. sphinx_structured_toc-0.1.0/tests/unit/test_item_parsing.py +171 -0
  54. sphinx_structured_toc-0.1.0/tests/unit/test_options.py +162 -0
  55. sphinx_structured_toc-0.1.0/tests/unit/test_section_fallback.py +93 -0
  56. sphinx_structured_toc-0.1.0/tests/unit/test_suppress_warnings.py +122 -0
  57. sphinx_structured_toc-0.1.0/uv.lock +1812 -0
sphinx_structured_toc-0.1.0/.gitignore ADDED
@@ -0,0 +1,90 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ pip-wheel-metadata/
24
+ share/python-wheels/
25
+ *.egg-info/
26
+ .installed.cfg
27
+ *.egg
28
+ *.snap
29
+ MANIFEST
30
+
31
+ # PyInstaller
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py,cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ .results.*.xml
53
+
54
+ # Sphinx documentation
55
+ docs/_build/
56
+ docs/spelling/
57
+
58
+ # Environments
59
+ .direnv
60
+ .env
61
+ .venv
62
+ env/
63
+ venv/
64
+ ENV/
65
+ env.bak/
66
+ venv.bak/
67
+
68
+ # mypy
69
+ .mypy_cache/
70
+ .dmypy.json
71
+ dmypy.json
72
+
73
+ # Pyre type checker
74
+ .pyre/
75
+
76
+ # Caches for various tools
77
+ /.*_cache/
78
+
79
+ # Test results
80
+ /results/
81
+ .test_output/
82
+
83
+ # direnv
84
+ .envrc
85
+
86
+ # Ignore version module generated by setuptools_scm
87
+ */_version.py
88
+
89
+ # Visual Studio Code
90
+ .vscode/
sphinx_structured_toc-0.1.0/.pre-commit-config.yaml ADDED
@@ -0,0 +1,26 @@
1
+ # See https://pre-commit.com for more information
2
+ # See https://pre-commit.com/hooks.html for more hooks
3
+ repos:
4
+ - repo: https://github.com/pre-commit/pre-commit-hooks
5
+ rev: "v5.0.0"
6
+ hooks:
7
+ - id: trailing-whitespace
8
+ - id: end-of-file-fixer
9
+ - id: check-yaml
10
+ - id: check-added-large-files
11
+ - id: check-merge-conflict
12
+ - id: check-toml
13
+ - id: fix-byte-order-marker
14
+ - id: mixed-line-ending
15
+ - repo: https://github.com/astral-sh/ruff-pre-commit
16
+ rev: "v0.11.13"
17
+ hooks:
18
+ - id: ruff
19
+ args: [--fix, --exit-non-zero-on-fix]
20
+ - id: ruff-format
21
+ - repo: https://github.com/pre-commit/mirrors-prettier
22
+ rev: ""
23
+ hooks:
24
+ - id: prettier
25
+ additional_dependencies:
26
+ - prettier@3.4.2
sphinx_structured_toc-0.1.0/.readthedocs.yaml ADDED
@@ -0,0 +1,25 @@
1
+ # Read the Docs configuration file
2
+ # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3
+
4
+ # Required
5
+ version: 2
6
+
7
+ # Set the OS, Python version, and other tools you might need
8
+ build:
9
+ os: ubuntu-24.04
10
+ tools:
11
+ python: "3.13"
12
+
13
+ # Build documentation in the "docs/" directory with Sphinx
14
+ sphinx:
15
+ configuration: docs/conf.py
16
+
17
+ # Install the project with the `docs` extra so the `furo` theme is
18
+ # available during the docs build.
19
+ # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
20
+ python:
21
+ install:
22
+ - method: pip
23
+ path: .
24
+ extra_requirements:
25
+ - docs