Skip to content
Snippets Groups Projects
  1. Oct 26, 2015
    • Dominic Kempf's avatar
      Implement some functionality for dune_cmake_sphinx_doc for custom docs. · 0a4d31eb
      Dominic Kempf authored
      In dune-testtools we built a sphinx cmake documentation which is customized
      quite a bit. With the core functionality being in dune-common, it is hard
      to maintain it twice. I have therefore added some options to the dune-common
      doc infrastructure, that are beneficial downstream.
      
      You can now:
      * provide custom rst sources
      * provide a custom sphinx-build conf file
      * limit the documentation to the current module, instead of adding all requirements automatically
      
      The defaults of all those parameters result in an unchanged behaviour
      (compared to before this commit).
      0a4d31eb
  2. Oct 15, 2015
  3. Oct 13, 2015
    • Dominic Kempf's avatar
      Adapt the infrastructure for a collected cmake API doc. · a4535b9a
      Dominic Kempf authored
      We do not want one such documentation per module, but instead
      we would allow people to use it from their module and get a
      documentation generated from all the dependent modules. This
      needs some changes to the machine.
      a4535b9a
    • Dominic Kempf's avatar
      Initial implementation of the sphinx-based CMake API documentation · 06f656c0
      Dominic Kempf authored
      This includes the following workflow:
      
      * The cmake module path is globbed for any modules matching *.cmake
      * The opening comment is parsed for the following rst directives:
        cmake_function, cmake_module, cmake_variables
      * From those, a browsable documentation is generated.
      
      To run properly, a python interpreter and sphinx are needed.
      06f656c0
Loading