Skip to content
Snippets Groups Projects
Forked from Core Modules / dune-common
Source project has a limited visibility.
  • Dominic Kempf's avatar
    0a4d31eb
    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
    History
    Implement some functionality for dune_cmake_sphinx_doc for custom docs.
    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).