summaryrefslogtreecommitdiffstats
path: root/Utilities/Sphinx
Commit message (Collapse)AuthorAgeFilesLines
* 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
|
* Help: Add new section for CPack generatorsKyle Edwards2018-06-212-0/+4
| | | | | | | | | | | | | | | | | | | | The documentation for CPack generators previously lived in their respective internal CMake modules. This setup was misleading, because it implied that you should include the modules in your own code, which is not the case. Moving the documentation into a separate section does a better job of hiding the internal modules, which are just an implementation detail. The generator documentation has also been modified to remove any references to the module name. The CPackIFW module is a special exception: since it has user-facing macros, the documentation for these macros has been kept in the module page, while all other documentation related to the IFW generator has been moved into the new section. To make it easier to find the new documentation, the old help pages for the CPack*.cmake modules have not been deleted, but have been replaced with a link to their respective help page in the new documentation section.
* Utilities/Sphinx: Add option to build and install Info manualOrivej Desh2018-06-121-1/+28
| | | | | Add option `SPHINX_INFO` to enable the Sphinx 'texinfo' builder and use the `makeinfo` tool to convert it to a `.info` file.
* Fix misc. typosluz.paz2018-06-041-1/+1
| | | | Found via `codespell` and `grep`
* Merge topic 'doc-code-block-highlight'Brad King2018-05-081-0/+1
|\ | | | | | | | | | | | | 8114b00b02 Utilities/Sphinx: Do not highlight unspecified code blocks as python Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2047
| * Utilities/Sphinx: Do not highlight unspecified code blocks as pythonBrad King2018-05-041-0/+1
| |
* | Utilities/Sphinx: Make HTML links in parsed-literal blocks more obviousBrad King2018-05-071-0/+10
|/ | | | | | | | Hyperlink text color does not stand out when used inside a literal block because such blocks typically get syntax highlighting. Update our CSS style to make the links more distinct. Suggested-by: Kyle Edwards <kyle.edwards@kitware.com>
* Utilities/Sphinx: Add role and directive for 'envvar' in CMake domainBrad King2018-04-192-0/+5
| | | | | | | | | | | | | | | | | | | | | | This enables cross-reference syntax for CMake environment variables: :envvar:`SOMEVAR` and definition of CMake environment variables via a directive: .. envvar:: SOMEVAR It also adds environment variables defined by the directive and by `Help/envvar/SOMEVAR.rst` documents to the index. This `envvar` role and directive is defined in our `cmake` domain and overrides the equivalent `envvar` role and directive provided by Sphinx in its default domain. This is okay because we build CMake documents in the `cmakd` domain. This follows up the work from commit v3.10.0-rc1~43^2 (Help: Document CMake's environment variables, 2017-09-01) that originally added `envvar` documentation.
* Utilities/Sphinx: Fix QtHelp generator identifiersBrad King2018-04-191-0/+1
| | | | Add missinge entry in `create_identifiers.py` helper.
* Require CMake 3.1 to build CMake itselfBrad King2017-08-101-1/+1
| | | | | This simplifies some policy settings and use of third-party libraries with imported targets.
* Utilities/Sphinx: Restore compatibility with Sphinx pre-1.2Björn Esser2017-08-021-2/+15
| | | | | | | | Since commit v3.8.0-rc2~28^2~2 (Utilities/Sphinx: Port cmake extension to Sphinx 1.4, 2017-02-09) we use the `sphinx.version_info` tuple. However, it was added in Sphinx v1.2 so the check breaks compatibility with older versions. Revise our check to assume Sphinx pre-1.2 if the version tuple does not exist.
* Utilities/Sphinx: Build documentation independently by defaultBrad King2017-05-011-12/+14
| | | | | | | Previously we made the `documentation` target depend on the executable targets. There is no real reason to do this other than serializing the documentation build output in terminals. Move this dependency behind an undocumented option so that it is not on by default.
* Utilities/Sphinx: Use brighter colors for html themeMatthew Woehlke2017-03-281-0/+20
| | | | | Set Sphinx `html_theme_options` to give the generated documentation a brighter and softer look than the default colors.
* Help/dev: Exclude this directory from user-facing documentationBrad King2017-03-011-1/+3
| | | | | | | Teach Sphinx and our own install rules to skip a `Help/dev` directory. This will give us a place to put developer-only documentation that should not be included in the user-facing documentation. Add a placeholder README.
* Merge topic 'sphinx-1.4'Brad King2017-02-102-7/+15
|\ | | | | | | | | | | | | 30abf145 Help: Fix cmake code block warnings produced by Sphinx 1.4 97917900 Utilities/Sphinx: Port qthelp css workaround to Sphinx 1.4 971384c2 Utilities/Sphinx: Port cmake extension to Sphinx 1.4
| * Utilities/Sphinx: Port qthelp css workaround to Sphinx 1.4Brad King2017-02-101-5/+9
| | | | | | | | | | | | The `default.css` static content is no longer placed in the qthelp `_static` directory. If it does not exist, skip over it and insert the content of `basic.css` directly into `cmake.css`.
| * Utilities/Sphinx: Port cmake extension to Sphinx 1.4Gregor Jasny2017-02-101-2/+6
| | | | | | | | | | | | | | | | Sphinx 1.4 introduced a breaking change to `indexnode` by changing the length of a tuple. Teach our extension to produce a tuple of the proper length for the version of Sphinx in use. This gets rid of the "4 column based index found" warning.
* | Utilities/Sphinx: Add option for cmake.org version switch to htmlBrad King2017-02-081-0/+12
|/ | | | | | Leave the option undocumented since it is not for general use. We can simply pass it through `SPHINX_FLAGS` when building for publication on `cmake.org`.
* Simplify CMake per-source license noticesBrad King2016-09-273-33/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | Per-source copyright/license notice headers that spell out copyright holder names and years are hard to maintain and often out-of-date or plain wrong. Precise contributor information is already maintained automatically by the version control tool. Ultimately it is the receiver of a file who is responsible for determining its licensing status, and per-source notices are merely a convenience. Therefore it is simpler and more accurate for each source to have a generic notice of the license name and references to more detailed information on copyright holders and full license terms. Our `Copyright.txt` file now contains a list of Contributors whose names appeared source-level copyright notices. It also references version control history for more precise information. Therefore we no longer need to spell out the list of Contributors in each source file notice. Replace CMake per-source copyright/license notice headers with a short description of the license and links to `Copyright.txt` and online information available from "https://cmake.org/licensing". The online URL also handles cases of modules being copied out of our source into other projects, so we can drop our notices about replacing links with full license text. Run the `Utilities/Scripts/filter-notices.bash` script to perform the majority of the replacements mechanically. Manually fix up shebang lines and trailing newlines in a few files. Manually update the notices in a few files that the script does not handle.
* Require CMake 2.8.12.2 to build CMake itselfBrad King2016-09-151-1/+1
| | | | | This will enable use of features such as ALIAS targets within CMake's own build.
* Utilities/Sphinx: Remove use of continue() methodKonstantin Podsvirov2016-08-021-8/+11
| | | | We currently only require CMake 2.8.4 which does not provide it.
* Install ccmake.1 and cmake-gui.1 conditionally with their tools (#15957)Brad King2016-02-081-0/+8
|
* Replace http://www.cmake.org URLs with https://cmake.orgBrad King2015-09-251-1/+1
| | | | | | | The latter is now the preferred URL for visiting cmake.org with a browser. Convert using the shell code: git ls-files -z | xargs -0 sed -i 's|http://www\.cmake|https://cmake|g'
* Utilities/Sphinx: Add CMake_OPTIONAL_COMPONENT macroBrad King2015-07-071-0/+3
| | | | | When building this directory independently define the macro since we will not get the definition from the top level of the source tree.
* CMake: New option CMake_INSTALL_COMPONENTSKonstantin Podsvirov2015-07-071-4/+8
| | | | | By default is OFF. Now it's used with CPack IFW himself installer.
* CMake: Install COMPONENTs (sphinx-man)Konstantin Podsvirov2015-07-071-1/+2
| | | | Added component sphinx-man
* CMake: Install COMPONENTsKonstantin Podsvirov2015-07-071-1/+3
| | | | | | | | | | | | | | | Added components: - cmake - ctest - cpack - cmake-gui - ccmake - data - sphinx-html - sphinx-singlehtml - sphinx-qthelp Other now Unspecified.
* Add option to pass custom flags to sphinx-build (#15545)Brad King2015-04-301-0/+4
| | | | | | | | Create a SPHINX_FLAGS cache entry that users can populate with command-line flags for sphinx-build. Add an option to the bootstrap script to populate it up front. Suggested-by: Felix Geyer <debfx@ubuntu.com>
* Help: Install Sphinx HTML object mapping fileGregor Jasny2015-03-221-2/+0
| | | | | | | | | To link CMake documentation from other documentation sets like KDE extra-cmake-modules the intersphinx extension depends on the objects.inv mapping file. The size overhead of 14k seems to be neglectable. Signed-off-by: Gregor Jasny <gjasny@googlemail.com>
* Merge topic 'doc-mixed-case-commands'Brad King2014-12-041-2/+10
|\ | | | | | | | | 607b39dc Utilities/Sphinx: Fix link targets for mixed-case command names
| * Utilities/Sphinx: Fix link targets for mixed-case command namesBrad King2014-12-041-2/+10
| | | | | | | | | | | | | | | | When a CMake domain 'command' object is defined by CMakeTransform or the 'cmake:command' directive, generate the link target with a lower-case name even if the command name is not all lower-case. This is needed to make cross-references to the command definition work since the 'cmake:command' role is marked with the 'lowercase' property.
* | Merge topic 'doc-sphinx-cmake-fixup'Brad King2014-11-181-0/+1
|\ \ | |/ | | | | | | 5cda2205 Utilities/Sphinx: Add missing call to note_explicit_target
| * Utilities/Sphinx: Add missing call to note_explicit_targetBrad King2014-11-171-0/+1
| | | | | | | | | | | | Sphinx calls document.note_explicit_target with any nodes.target() it creates. Add such a call when we create a document target in CMakeTransform.
* | Merge topic 'doc-index-xrefs'Brad King2014-11-122-3/+47
|\ \ | |/ | | | | | | 7ca9a459 Utilities/Sphinx: Add index entries for cross-references
| * Utilities/Sphinx: Add index entries for cross-referencesBrad King2014-11-122-3/+47
| | | | | | | | | | | | | | Add a document transform to insert index and target nodes just before any CMake domain cross-reference node. This will make references to CMake domain objects appear in the index. Also add a comment explaining why it cannot be done in a result_nodes method of the CMakeXRefRole.
* | Help: Fix broken cross-references reported by 'nitpicky' optionBrad King2014-11-071-0/+2
| | | | | | | | | | Enable the Sphinx 'nitpicky' option and fix the resulting warnings about dangling references.
* | Utilities/Sphinx: Fix html_favicon configurationBrad King2014-11-071-1/+1
|/ | | | | | | | | | | The value must be either a full path or relative to the configuration directory, not relative to the 'static' directory. Use a full path. This avoids a warning: WARNING: favicon file 'cmake-favicon.ico' does not exist It worked before because all 'static' directory content is copied to the '_static' directory of html output anyway.
* Help: Fix QtHelp commands on WindowsNils Gladitz2014-07-281-2/+7
| | | | | | | Explicitly invoke python script through the interpreter since windows does not act on hashbangs. Use the found qcollectiongenerator executable rather than what happens to be in PATH.
* Help: Identify more artifact types in QtHelp documentation.Stephen Kelly2014-07-171-7/+21
| | | | | | Add identifiers for variables, properties, policies and modules. This will allow QtCreator to show relevant documentation if it learns more about the context of the contents of cmake files.
* Help: Add context to titles in QtHelp.Stephen Kelly2014-06-171-0/+6
| | | | This allows disambiguation of identifiers in Qt Assistant and Creator.
* Help: Create proper identifiers for keywords in QtHelp.Stephen Kelly2014-06-172-0/+37
| | | | | | | | | This is necessary in order for the QHelpEngineCore::linksForIdentifier API to work. http://doc-snapshot.qt-project.org/qt5-5.3/qhelpenginecore.html#linksForIdentifier That API is used by QtCreator to enable contextual links to help files.
* Add an "installed file" property scopeNils Gladitz2014-05-281-0/+4
| | | | | | | Teach set_property and get_property an "INSTALL" property type to be associated with install-tree file paths. Make the properties available to CPack for use during packaging. Add a "prop_inst" Sphinx domain object type for documentation of such properties.
* Merge branch 'master' into doc-singlehtmlBrad King2014-04-245-1/+102
|\ | | | | | | | | Resolve conflicts in Utilities/Sphinx/CMakeLists.txt by adding the help options from both sides.
| * Merge topic 'sphinx-python3'Brad King2014-04-241-1/+4
| |\ | | | | | | | | | | | | d55671ad Utilities/Sphinx: Fix cmake domain document removal with python3
| * \ Merge topic 'sphinx-python3'Brad King2014-04-182-4/+4
| |\ \ | | | | | | | | | | | | | | | | 69069cfb Utilities/Sphinx: Port documentation generation to python3 (#14886)
| * | | Help: Fix installation of the Qt qch file.Stephen Kelly2014-04-141-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | The file was changed to have the version in its name in commit 111bb67c (Help: Use a more-appropriate qthelp namespace and file name., 2014-04-10).
| * | | Help: Use a more-appropriate qthelp namespace and file name.Stephen Kelly2014-04-103-0/+41
| | | | | | | | | | | | | | | | | | | | Use the namespace org.cmake instead of org.sphinx.cmake. Add the version to the output file name.
generated by cgit v0.12 at 2024-11-11 12:52:25 (GMT)