File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -15,4 +15,5 @@ Generate documentation for :term:`Sphinx` with :term:`CMake`.
1515 tutorial
1616 api_reference
1717 release/index
18+ Source Code @ GitHub <https://github.com/python-cmake/sphinx-cmake >
1819 glossary
Original file line number Diff line number Diff line change @@ -61,3 +61,19 @@ View the result in your browser at::
6161
6262 file:///path/to/sphinx-build/build/doc/html/index.html
6363
64+ .. _installing/deployment :
65+
66+ Package Deployment
67+ ==================
68+
69+ This package is deployed as a source on `PyPi <https://pypi.org/project/sphinx-cmake/ >`_
70+ to allow dynamic adaptation of :term: `CMake ` scripts based on the version of :term: `Sphinx `
71+ available at installation. Packaging it as a
72+ `wheel <https://packaging.python.org/en/latest/specifications/binary-distribution-format >`_
73+ would lock the :term: `Sphinx ` version detected during the packaging and deployment process,
74+ reducing flexibility and compatibility with future versions.
75+
76+ If you wish to deploy the package as a source within a custom index, it is important to include
77+ the build requirements in your environment (e.g. "hatchling" and "cmake").
78+
79+ .. seealso :: `Package Formats <https://packaging.python.org/en/latest/discussions/package-formats>`_
Original file line number Diff line number Diff line change 44Release Notes
55*************
66
7+ .. release :: Upcoming
8+
9+ .. change :: fixed
10+
11+ Corrected the CMake version upper bound from 3.30 to 3.31.
12+
13+ .. change :: changed
14+
15+ Added documentation for :ref: `installing/deployment `.
16+
17+ .. change :: changed
18+
19+ Added link to Github Project in documentation.
20+
721.. release :: 0.2.1
822 :date: 2024-08-17
923
Original file line number Diff line number Diff line change 22requires = [
33 " hatchling >= 1.4; python_version >= '3'" ,
44 " setuptools >= 44; python_version < '3'" ,
5- " cmake >= 3.20, < 3.30 "
5+ " cmake >= 3.20, < 3.31 "
66]
77build-backend = " build_backend"
88backend-path = [" ." ]
You can’t perform that action at this time.
0 commit comments