summaryrefslogtreecommitdiffstats
path: root/Utilities/Sphinx/create_identifiers.py
Commit message (Collapse)AuthorAgeFilesLines
* Sphinx: Modernize UTF-8 encoding handling when updating CMake.qhpCraig Scott2023-04-071-4/+4
|
* Utilities/Sphinx: Add role and directive for 'genex' in CMake domainBrad King2021-01-181-0/+1
| | | | | | | | | | | | | | | | | 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.
* 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: Index guide-level documents for cross-referencingBrad King2020-01-131-0/+1
| | | | | | 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.
* Help: Add new section for CPack generatorsKyle Edwards2018-06-211-0/+1
| | | | | | | | | | | | | | | | | | | | 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 role and directive for 'envvar' in CMake domainBrad King2018-04-191-0/+1
| | | | | | | | | | | | | | | | | | | | | | 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.
* Utilities/Sphinx: Add index entries for cross-referencesBrad King2014-11-121-1/+1
| | | | | | | 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: 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: Create proper identifiers for keywords in QtHelp.Stephen Kelly2014-06-171-0/+32
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.