summaryrefslogtreecommitdiffstats
path: root/Utilities/Sphinx
Commit message (Collapse)AuthorAgeFilesLines
* 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.
| * | | Help: Workaround Qt 4.8 assistant bug in CSS handling.Stephen Kelly2014-04-012-0/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Assistant in Qt 4.8 does not handle css import paths relative to the includer. This is fixed in Qt 4.8 commit b95750a275 (Assistant: Set the url on created QNetworkReply objects., 2014-03-31). It is unknown whether there will be a further Qt 4.8 release containing that commit. Use a CMake script to pre-replace the content prior to generating the qch file. An alternative workaround of moving the files or adding "_static" to the import path did not seem to work for existing Qt 4.8 versions. The bug was fixed in the Qt 5 branch before Qt 5.0. The Qt 5 assistant renders this workaround'ed version correctly too.
| * | | Help: Add option to create and install Qt .qch file.Stephen Kelly2014-03-312-1/+41
| | | |
* | | | Utilities/Sphinx: Add option to build 'singlehtml' formatBrad King2014-04-241-1/+13
| |_|/ |/| | | | | | | | Add SPHINX_SINGLEHTML to enable the Sphinx 'singlehtml' builder.
* | | Utilities/Sphinx: Fix cmake domain document removal with python3Brad King2014-04-241-1/+4
| |/ |/| | | | | | | | | In the domain clear_doc method, avoid removing entries from a dictionary while iterating over it. Instead accumulate a set of entries to remove at the end.
* | Utilities/Sphinx: Port documentation generation to python3 (#14886)Uwe L. Korn2014-04-182-4/+4
|/
* Utilities/Sphinx: Add option to build 'text' formatBrad King2014-02-041-1/+7
| | | | | | | Add SPHINX_TEXT to enable the Sphinx 'text' builder. Mark it as advanced and do not add install rules. This is intended for use by the release manager to build the release notes in text format suitable for email.
* Help: Do not install Sphinx html build info filesBrad King2014-01-281-1/+4
| | | | | Exclude '.buildinfo' and 'objects.inv' from installation as part of the Sphinx-generated html documentation.
* Help: Workaround pygments reporting an error for genexes.Stephen Kelly2014-01-041-0/+10
| | | | | Without the workaround, CMake code snippets are not highlighted at all because pygments can not lex the generator expressions.
* Help: Remove workaround for pre-CMake 2.8.4 code.Stephen Kelly2014-01-041-2/+1
| | | | | | The requirement was updated in commit 920ffbf5 (Require CMake 2.8.4 or greater to build CMake, 2013-10-11) and similar snippets were removed.
* Help: Fix Sphinx extension with docutils < 0.11Alex Neundorf2013-12-231-1/+6
| | | | | | | In older versions of python docutils "error_reporting" was not in the "utils" subpackage, so try the older location if the new one failed. Alex
* Help: Parse Copyright.txt instead of using current yearBrad King2013-11-132-2/+10
| | | | | | | Configure our Sphinx conf.py with a copyright line extracted from Copyright.txt instead of using the year in which the documentation is built. This will future-proof the reported copyright year range when building documentation for old versions.
* Help: Configure html faviconBrad King2013-11-052-0/+1
|
* Help: Configure html page navigation barsBrad King2013-11-053-0/+17
| | | | | Add a small CMake logo to the left side of the header and footer navigation bars. Set the html theme, title, and short title explicitly.
* Help: Configure |version| replacement correctlyBrad King2013-11-041-1/+1
| | | | | Fix our configuration of the Sphinx conf.py 'version' entry to refer to the correctly-spelled CMake_VERSION_(MAJOR|MINOR|PATCH) variables.
* Help: Configure copyright year automaticallyBrad King2013-11-042-3/+3
| | | | | Teach our Sphinx conf.py to compute the copyright end year automatically. Drop our hard-coded configuration for it.
* Merge topic 'doc-conf-auto-manuals'Brad King2013-10-302-15/+25
|\ | | | | | | | | f88332f Help: Glob manual/*.rst in Sphinx configuration
| * Help: Glob manual/*.rst in Sphinx configurationBrad King2013-10-302-15/+25
| | | | | | | | | | | | | | Add the man page description line as explicit markup at the top of each Help/manual/*.rst file and scan it from conf.py to automatically generate the man_pages Sphinx configuration value. This reduces the number of places that need to be changed when a new manual is added.
* | Configure Utilities/Sphinx for standalone build with CTestBrad King2013-10-291-0/+1
|/ | | | | | Include the CTestUseLaunchers module in the standalone build of Utilities/Sphinx so that it can be built under CTest with the CTEST_USE_LAUNCHERS option.
* cmRST: Teach cmake-module directive to scan bracket commentsBrad King2013-10-231-10/+27
| | | | | | | | | | | | | | | | When scanning CMake module files for .rst comments, recognize bracket comments starting in ".rst:" too. For example: #[[.rst: Include the bracket comment content terminated by the closing bracket. Exclude the line containing the bracket if it starts in "#". Teach the CMakeLib.testRST test to cover multiple bracket lengths and ending brackets on lines with and without "#". Update the cmake-developer.7 manual to document the bracket-comment syntax for .rst documentation.
* Help: Add cmake-developer.7 manualBrad King2013-10-221-0/+1
| | | | | Add the manual with just an introduction section. Leave section headers for Help and Modules to be filled in later.
* Help: Factor out cmake-generator-expressions manual pageBrad King2013-10-161-0/+1
| | | | | | | | | Generator expressions are supported in many places and are a distinct concept worthy of their own manual page. The old builtin documentation was previously represented by preprocessor macros to generate it into each place that supports them. Factor out the duplicate content into a dedicated cmake-generator-expressions manual page and reference it from each original location.
* Build Help documentation during CMake build using SphinxBrad King2013-10-165-0/+444
Add a Utilities/Sphinx directory to hold CMake build code to run the Sphinx (sphinx-doc.org) documentation generation tool. Create a CMakeLists.txt file there capable of building either as a subdirectory of the main CMake build, or as a standalone documentation build. Add cache options SPHINX_MAN and SPHINX_HTML to select output formats and SPHINX_EXECUTABLE to specify the sphinx-build executable. Add bootstrap options --sphix-man and --sphinx-html to select output formats and --sphinx-build=<sb> to specify the sphinx-build executable. Create a "conf.py.in" file to configure_file into "conf.py" to tell sphinx-build how to build our documents. Create a "cmake.py" Sphinx extension module defining: * The "cmake-module" directive used in Help/module/*.rst files to scan .rst markup from the corresponding Modules/*.cmake file. * A Sphinx domain called "cmake" defining documentation object types for CMake Help/<type> directories: command, generator, manual, module, policy, prop_*, and variable. Add a "role" for each type to perform cross-references. Teach the roles to treat "<XYZ>" as placeholders instead of explicit targets if not preceded by a space. Add cmake domain directives to define command and variable objects explicitly in .rst file content. This will allow modules to define their own commands and variables and have them indexed and linkable. * A Sphinx document transform that converts Help/<type>/*.rst documents into cmake domain objects of the corresponding <type> and adds index entries for them. This will automatically index all CMake documentation objects and provide cross-reference targets for them with no special markup in the .rst files.
generated by cgit v0.12 at 2024-11-12 20:09:39 (GMT)