summaryrefslogtreecommitdiffstats
path: root/Utilities/Sphinx
Commit message (Collapse)AuthorAgeFilesLines
* 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
|
* Utilities/Sphinx: Index guide-level documents for cross-referencingBrad King2020-01-132-0/+4
| | | | | | Extend the change from commit d2fde94809 (Help: Add infrastructure for guide-level documentation, 2019-05-30, v3.16.0-rc1~531^2~4) to add support for cross-referencing and indexing the guides.
* Utilities/Sphinx: Index document types only by top level directoryBrad King2020-01-131-1/+1
| | | | | | | We use the convention `Help/<type>/<doc>` for indexing each document as an object of type `<type>`. Split the document name on the first slash rather than the last slash so that multi-level documents like `Help/guide/tutorial/index.rst` are indexed as their top-level type.
* Configure CMake itself with policies through CMake 3.15Brad King2019-08-231-1/+1
| | | | | | In particular, set `CMP0091` to `NEW` to enable the MSVC runtime library abstraction so it can be set via `CMAKE_MSVC_RUNTIME_LIBRARY` in the cache.
* CMakeVersion: Move computation logic to main scriptBrad King2019-07-291-1/+1
|
* CMake.qch: Don't include the version in the file nameCraig Scott2019-07-173-12/+2
| | | Fixes: #19374
* Configure CMake itself with policies through CMake 3.14Brad King2019-05-081-1/+1
| | | | | In particular, set `CMP0082` to `NEW` to interleave install commands in the top-level directory with subdirectory installations.
* Merge topic 'fetchcontent-reduce-boilerplate'Brad King2019-01-301-1/+4
|\ | | | | | | | | | | | | | | | | a94355c7b7 FetchContent: Add new command FetchContent_MakeAvailable() 611d5274de Sphinx: Add limited support for nested variables in docs 1a07e1b47d FetchContent: Trivial doc corrections Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2830
| * Sphinx: Add limited support for nested variables in docsCraig Scott2019-01-261-1/+4
| | | | | | | | This is needed to allow example code to contain content like `${some_${foo}_bar}`.
* | Reduce size of PNG imagesLucy Phipps2019-01-251-0/+0
|/ | | | | | Use FileOptimizer 13.50.2431 (x86) and ZopfliPNG 1.0.2. Update expected file hashes in tests.
* Help: CMakeTemplateStyle uses colors that better contrast.Robert Maynard2019-01-091-5/+5
|
* Merge topic 'cmake-through-3.12'Brad King2018-10-191-1/+1
|\ | | | | | | | | | | | | 95b4b9137a Declare support for CMake versions through 3.12 for own build Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2496
| * Declare support for CMake versions through 3.12 for own buildBrad King2018-10-171-1/+1
| | | | | | | | | | | | | | | | | | | | CMake 3.12 introduced a `...<max>` syntax in the version given to `cmake_minimum_required` to automatically set policies to NEW up to that version. Use it to avoid listing policies explicitly. The syntax is compatible with older versions of CMake such that they use the extended version string for the `CMAKE_MINIMUM_REQUIRED_VERSION` variable (which we don't use) but otherwise ignore it.
* | Help: Override pygments CMakeLexer to support <..> and [..]Joachim Wuttke (o)2018-10-183-6/+77
|/ | | | | | | | | | | | | | | | | | | | | | * The code snippets in the docs consist of CMake code mixed with syntax definition punctuation like < > [ ] ... Therefore a pure CMake lexer is inadequate. Here it is replaced by a CMake syntax definition parser. * Fixed syntax definition snippets in FindPkgConfig.cmake to make best use of syntax highlighting. This source file is the hardest to support because it contains comparison operators <= = >=, which need special attention to avoid confusion with the placeholder indicators <...>. * Fixed syntax in execute_process.rst (there were unbalanced brackets). * Disabled syntax highlighting for long string examples in cmake-language.7.rst. * No highlighting of removed syntax in CMP0049 * To inspect the outcome of this patch, see e.g. the pages * manual/cmake-buildsystem.7.html * module/ExternalProject.html * module/FindPkgConfig.html which are particularly rich in complex code snippets.
* cmake-gui: Update iconsT.J. Corona2018-08-162-0/+0
|
generated by cgit v0.12 at 2025-01-31 13:05:24 (GMT)