summaryrefslogtreecommitdiffstats
path: root/Utilities/Sphinx
Commit message (Collapse)AuthorAgeFilesLines
...
* | Utilities/Sphinx: support cmakedomain running in parallelHenry Schreiner2022-10-241-0/+1
| | | | | | | | | | | | Fixes: #24076 Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
* | Configure CMake itself with policies through CMake 3.24Brad King2022-10-121-1/+1
|/
* Utilities/Sphinx: Avoid deprecated docutils error handling helpersBrad King2022-10-111-12/+6
| | | | | | | | | | The `SafeString` and `ErrorString` classes are deprecated and will be removed in Docutils 0.21 or later. They help avoid encoding errors during exception handling in Python <= 2.7, but these days we always use Python 3 to build the documentation, at least during development, when error cases are most likely to occur. Fixes: #24039
* Build: Modernize some `foreach` calls to use `IN LISTS`/`IN ITEMS`Alex Turbov2022-09-221-9/+3
|
* QtHelp: Update Sphinx issue URLs in commentsFeRD (Frank Dana)2022-09-041-2/+2
| | | | | | The QtHelp Sphinx generation code contains two links to Sphinx issues that used old, dead BitBucket URLs. Those issues were migrated to GitHub, so the dead links can be replaced with working ones.
* Configure CMake itself with policies through CMake 3.23Brad King2022-06-141-1/+1
|
* Merge topic 'doc-cmake.org-tutorial-archive'Brad King2022-04-292-6/+54
|\ | | | | | | | | | | | | | | | | 4cb616fed6 Tutorial: Provide a source archive when published on cmake.org 37fb70591e Utilities/Sphinx: Add variables listing pre-sphinx commands eb7d913a21 Utilities/Sphinx: Clarify names of variables listing post-sphinx commands Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7215
| * Tutorial: Provide a source archive when published on cmake.orgBrad King2022-04-282-0/+46
| | | | | | | | | | | | | | | | | | Provide readers following the tutorial on `cmake.org` a direct link to download the tutorial's source examples. Previously readers had to fetch the CMake source tree separately and look for the tutorial source examples inside it. Fixes: #22475
| * Utilities/Sphinx: Add variables listing pre-sphinx commandsBrad King2022-04-271-0/+2
| |
| * Utilities/Sphinx: Clarify names of variables listing post-sphinx commandsBrad King2022-04-271-6/+6
| |
| * Merge branch 'doc-qhelpgenerator' into release-3.23Brad King2022-04-081-6/+6
| |\ | | | | | | | | | Merge-request: !7150
| * \ Merge topic 'ci-cmake.org-help' into release-3.23Brad King2022-04-061-0/+6
| |\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | b691906d27 gitlab-ci: Build qthelp-format release documentation for cmake.org 1ceec19c20 gitlab-ci: Add objects.inv to cmake.org html documentation Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7146
| * \ \ Merge topic 'ci-cmake.org-help' into release-3.23Brad King2022-04-054-6/+85
| |\ \ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 2808281730 gitlab-ci: update cmake.org documentation in release package pipeline ed00a29cce gitlab-ci: consolidate jobs for cmake.org/cmake/help/git-{master,stage} docs 5c2e8ce515 Utilities/Sphinx: Add OpenSearch link to html page headers on cmake.org a14905d4df Utilities/Sphinx: Add option to build outdated version banner for cmake.org cca73b54ae Utilities/Sphinx: Add undocumented option to build docs for cmake.org Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7144
* | | | | CMake: Use FindPython instead of FindPythonInterp to build CMake itselfKyle Edwards2022-04-211-2/+2
| | | | | | | | | | | | | | | | | | | | Fixes: #23444
* | | | | Merge topic 'doc-qhelpgenerator'Brad King2022-04-081-6/+6
|\ \ \ \ \ | | |_|_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | bf69fa32c4 Utilities/Sphinx: Update qthelp generation to qhelpgenerator 37904abb58 Help: Add "Updates" section header in 3.22 release notes Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7150
| * | | | Utilities/Sphinx: Update qthelp generation to qhelpgeneratorBrad King2022-04-071-6/+6
| | |_|/ | |/| | | | | | | | | | `qcollectiongenerator` is deprecated in favor of `qhelpgenerator`.
* | | | Merge topic 'ci-cmake.org-help'Brad King2022-04-061-0/+6
|\ \ \ \ | |/ / / | | | | | | | | | | | | | | | | | | | | | | | | b691906d27 gitlab-ci: Build qthelp-format release documentation for cmake.org 1ceec19c20 gitlab-ci: Add objects.inv to cmake.org html documentation Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7146
| * | | gitlab-ci: Build qthelp-format release documentation for cmake.orgBrad King2022-04-061-0/+6
| | |/ | |/| | | | | | | | | | Previously the qthelp-format release documentation on `cmake.org` was built manually.
* | | Merge branch 'backport-ci-cmake.org-help' into ci-cmake.org-helpBrad King2022-04-054-6/+85
|\ \ \ | |/ /
| * | Utilities/Sphinx: Add OpenSearch link to html page headers on cmake.orgBrad King2022-04-052-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | Reference an OpenSearch description file that sits outside the content of any specific version so we only need to maintain one and so that it can reference the latest version. This was previously added in a custom branch for building the cmake.org reference documentation.
| * | Utilities/Sphinx: Add option to build outdated version banner for cmake.orgBrad King2022-04-053-0/+29
| | | | | | | | | | | | | | | This was previously added in a custom branch for building the cmake.org reference documentation.
| * | Utilities/Sphinx: Add undocumented option to build docs for cmake.orgBrad King2022-04-053-6/+50
| | |
* | | Require CMake 3.13+ to configure CMake itselfBrad King2022-02-221-1/+1
| | | | | | | | | | | | | | | | | | In particular, guarantee that policy `CMP0077` has `NEW` behavior. This will be useful to hard-code options of third-party libraries without polluting our own cache.
* | | Configure CMake itself with policies through CMake 3.22Brad King2022-02-031-1/+1
| |/ |/|
* | Utilities/Sphinx: Ignore warning in generated texinfo documentationBrad King2022-02-012-0/+4
| |
* | Configure CMake itself with policies through CMake 3.21Brad King2021-10-081-1/+1
|/
* Utilities/Sphinx: Print path to index.html in build outputArcturus Arcturus2021-10-041-0/+7
| | | | | Print the url to index.html in the build output, just so one can "open in browser" from the context menu in some terminals.
* Configure CMake itself with policies through CMake 3.20Brad King2021-06-301-1/+1
|
* Utilities/Sphinx: Index guide section documents for cross-referencingBrad King2021-06-171-0/+11
| | | | | | | | Extend the change from commit 6185265800 (Utilities/Sphinx: Index guide-level documents for cross-referencing, 2019-12-06, v3.17.0-rc1~181^2~1) to name guide documents other than the top level using their docname instead of their title. This will allow them to be cross-referenced by a stable name even if their title changes.
* Merge topic 'sphinx-4'Brad King2021-05-141-0/+1
|\ | | | | | | | | | | | | bb9c69ed70 Utilities/Sphinx: Update man page config for Sphinx 4 Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6126
| * Utilities/Sphinx: Update man page config for Sphinx 4Brad King2021-05-141-0/+1
| | | | | | | | | | | | | | | | Sphinx 4 by default generates `man/#/foo.#`, but older versions generate `man/foo.#` as our install rules expect. Update our Sphinx config file to tell Sphinx 4 to use the old layout. Fixes: #22192
* | Utilities: Fix typos and spelling in commentsJosef Angstenberger2021-05-071-1/+1
| |
* | Help: Add option to generate docs with latexpdfHenryk Paluch2021-03-011-17/+48
| |
* | Merge topic 'doc-presets'Brad King2021-02-181-0/+1
|\ \ | |/ | | | | | | | | | | | | | | | | 47ab2d4d2e Help: Clarify role of binaryDir inheritance in cmake-presets(7) 0e3c361f77 Help: Link to tool-specific preset arguments from cmake-presets(7) dd6165fbd4 Help: Mention version 2 in cmake-presets(7) cdbd1ae64b Utilities/Sphinx: Avoid converting -- to an en-dash Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5829
| * Utilities/Sphinx: Avoid converting -- to an en-dashBrad King2021-02-181-0/+1
| |
* | Configure CMake itself with policies through CMake 3.19Brad King2021-02-101-1/+1
|/
* Utilities/Sphinx: Add role and directive for 'genex' in CMake domainBrad King2021-01-182-2/+20
| | | | | | | | | | | | | | | | | This enables cross-reference syntax for CMake generator expressions: :genex:`SOME_GENEX` :genex:`$<SOME_GENEX>` :genex:`$<SOME_GENEX:...>` and definition of CMake generator expressions via a directive: .. genex:: SOME_GENEX .. genex:: $<SOME_GENEX> .. genex:: $<SOME_GENEX:...> It also adds generator expressions defined by the directive and by `Help/genex/SOME_GENEX.rst` documents to the index.
* Help: Improve styling for versionadded/deprecated directivesNikita Nemkin2020-12-021-0/+6
| | | | | | | Sphinx theme CSS removes top margin for dd > p combination, but directives add an intervening div and need a separate rule. Issue: #19715
* Merge topic 'doc-html-lang'Brad King2020-11-091-0/+1
|\ | | | | | | | | | | | | f25e4313ac Utilities/Sphinx: Tell Sphinx that documentation is written in English Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5480
| * Utilities/Sphinx: Tell Sphinx that documentation is written in EnglishBrad King2020-11-091-0/+1
| | | | | | | | Fixes: #21409
* | Configure CMake itself with policies through CMake 3.18Brad King2020-10-131-1/+1
|/
* Utilities/Sphinx: Avoid using deprecated sphinx APIsBrad King2020-10-051-19/+23
| | | | | | | | Sphinx has deprecated `sphinx.util.pycompat.htmlescape` and `sphinx.builders.qthelp.QtHelpBuilder`. We only import these as part of a monkey-patch to work around a bug in versions of sphinx before 1.7.2, so make that code path conditional. The imports are not deprecated on the versions where we need them.
* Utilities/Sphinx: Clarify check for sphinx < 1.4Brad King2020-10-051-8/+4
|
* Utilities/Sphinx: Add script for inserting ".. versionadded" directiveNikita Nemkin2020-07-031-0/+115
|
* CTestConfig: allow nightly build submission using httpsRolf Eike Beer2020-06-091-1/+3
| | | | | The idea is that one may set `CTEST_DROP_METHOD` in custom CTest scripting.
* Sphinx/create_identifiers: handle qhp contents as utf-8Ben Boeckel2020-06-031-4/+4
|
* Sphinx/create_identifiers: use `not in` not `not _ in`Ben Boeckel2020-06-031-1/+1
|
* Sphinx/create_identifiers: remove unused importBen Boeckel2020-06-031-1/+1
|
* Utilities/Sphinx: allow CDash submission for the standalone buildBen Boeckel2020-05-071-0/+14
|
* Utilities/Sphinx: support finding Qt5's qcollectiongenerator tooBen Boeckel2020-05-071-1/+1
|
generated by cgit v0.12 at 2025-01-11 16:04:40 (GMT)