1. 21 Jun, 2018 1 commit
    • Kyle Edwards's avatar
      Help: Add new section for CPack generators · 2a2829cc
      Kyle Edwards authored
      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.
      2a2829cc
  2. 12 Jun, 2018 1 commit
  3. 04 Jun, 2018 1 commit
  4. 07 May, 2018 1 commit
  5. 04 May, 2018 1 commit
  6. 19 Apr, 2018 2 commits
    • Brad King's avatar
      Utilities/Sphinx: Add role and directive for 'envvar' in CMake domain · 8acf46ca
      Brad King authored
      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.
      8acf46ca
    • Brad King's avatar
      Utilities/Sphinx: Fix QtHelp generator identifiers · 7e532abc
      Brad King authored
      Add missinge entry in `create_identifiers.py` helper.
      7e532abc
  7. 10 Aug, 2017 1 commit
  8. 02 Aug, 2017 1 commit
    • Björn Esser's avatar
      Utilities/Sphinx: Restore compatibility with Sphinx pre-1.2 · 2a68ff7f
      Björn Esser authored
      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.
      2a68ff7f
  9. 01 May, 2017 1 commit
    • Brad King's avatar
      Utilities/Sphinx: Build documentation independently by default · c273906f
      Brad King authored
      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.
      c273906f
  10. 28 Mar, 2017 1 commit
  11. 01 Mar, 2017 1 commit
  12. 10 Feb, 2017 2 commits
  13. 08 Feb, 2017 1 commit
  14. 27 Sep, 2016 1 commit
    • Brad King's avatar
      Simplify CMake per-source license notices · 86578ecc
      Brad King authored
      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.
      86578ecc
  15. 15 Sep, 2016 1 commit
  16. 02 Aug, 2016 1 commit
  17. 08 Feb, 2016 1 commit
  18. 25 Sep, 2015 1 commit
  19. 07 Jul, 2015 4 commits
  20. 30 Apr, 2015 1 commit
  21. 22 Mar, 2015 1 commit
  22. 04 Dec, 2014 1 commit
    • Brad King's avatar
      Utilities/Sphinx: Fix link targets for mixed-case command names · 607b39dc
      Brad King authored
      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.
      607b39dc
  23. 17 Nov, 2014 1 commit
  24. 12 Nov, 2014 1 commit
    • Brad King's avatar
      Utilities/Sphinx: Add index entries for cross-references · 7ca9a459
      Brad King authored
      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.
      7ca9a459
  25. 07 Nov, 2014 2 commits
    • Brad King's avatar
      Help: Fix broken cross-references reported by 'nitpicky' option · 4c8c442d
      Brad King authored
      Enable the Sphinx 'nitpicky' option and fix the resulting warnings about
      dangling references.
      4c8c442d
    • Brad King's avatar
      Utilities/Sphinx: Fix html_favicon configuration · 5088e0a0
      Brad King authored
      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.
      5088e0a0
  26. 29 Oct, 2014 1 commit
    • Brad King's avatar
      Utilities/Sphinx: Fix html_favicon configuration · ca83c39c
      Brad King authored
      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.
      ca83c39c
  27. 28 Jul, 2014 1 commit
    • Nils Gladitz's avatar
      Help: Fix QtHelp commands on Windows · 9e5e7e71
      Nils Gladitz authored
      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.
      9e5e7e71
  28. 17 Jul, 2014 1 commit
  29. 17 Jun, 2014 2 commits
  30. 28 May, 2014 1 commit
    • Nils Gladitz's avatar
      Add an "installed file" property scope · 15a8af21
      Nils Gladitz authored
      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.
      15a8af21
  31. 24 Apr, 2014 2 commits
  32. 18 Apr, 2014 1 commit