[cmake-developers] [CMake 0015587]: Add more RST markup to documentation

Mantis Bug Tracker mantis at public.kitware.com
Tue May 26 17:26:49 EDT 2015


The following issue has been SUBMITTED. 
====================================================================== 
http://public.kitware.com/Bug/view.php?id=15587 
====================================================================== 
Reported By:                Stephen Kelly
Assigned To:                
====================================================================== 
Project:                    CMake
Issue ID:                   15587
Category:                   (No Category)
Reproducibility:            have not tried
Severity:                   minor
Priority:                   normal
Status:                     new
====================================================================== 
Date Submitted:             2015-05-26 23:26 CEST
Last Modified:              2015-05-26 23:26 CEST
====================================================================== 
Summary:                    Add more RST markup to documentation
Description: 
There are lots of places in the CMake documentation which have suboptimal
reStructuredText formatting. Fixing up some of that would be great. There is
information about writing help files here:

 http://www.cmake.org/cmake/help/v3.0/manual/cmake-developer.7.html#help

For example on this page, the CMAKE_PARENT_LIST_FILE could be a link, but is
currently not:

 http://www.cmake.org/cmake/help/v3.0/variable/CMAKE_CURRENT_LIST_FILE.html

There are many other examples and it would make a huge improvement to the
documentation to systematically improve documentation pages like that.
====================================================================== 

Issue History 
Date Modified    Username       Field                    Change               
====================================================================== 
2015-05-26 23:26 Stephen Kelly  New Issue                                    
======================================================================



More information about the cmake-developers mailing list