Skip to content
Snippets Groups Projects
  1. Jul 30, 2019
  2. Mar 28, 2019
  3. Mar 27, 2019
  4. Mar 26, 2019
  5. Mar 18, 2019
  6. Mar 14, 2019
  7. Mar 06, 2019
  8. Feb 14, 2019
  9. Mar 27, 2018
  10. Dec 19, 2017
  11. Nov 17, 2017
  12. Nov 16, 2017
  13. May 25, 2017
  14. Apr 21, 2017
  15. Feb 24, 2017
  16. Nov 21, 2016
  17. Nov 14, 2016
  18. Oct 25, 2016
  19. Oct 24, 2016
  20. Oct 06, 2016
  21. Aug 16, 2016
  22. Aug 12, 2016
    • Mathieu Duponchelle's avatar
      Documentation: port to hotdoc 0.8 · a51dcfd9
      Mathieu Duponchelle authored
      
      + Use the hotdoc autotools helpers
      
      This requires using -Wno-portability in the call to AM_INIT_AUTOMAKE,
      as discussed with Simon it's a reasonable requirement for using the
      hotdoc.mk fragment Makefile.
      
      The produced html is now cleanly installable and uninstallable.
      
      + Make documentation build parallel for croesor and rhosydd
      
      The issue preventing this is fixed upstream, although in a
      different manner than the linked github issue proposed.
      
      + Remove distribution of the generated documentation
      
      Distributing build products in the source tarball is a bad practice,
      and there's no compelling reason for doing this in Apertis libraries.
      
      + Use a sitemap
      
      This means subpages do not need to be linked and updated in markdown
      files.
      
      + Enable ‘smart index’
      
      + Enable devhelp books generation
      
      + Update the debian files
      
      + remove build-depends on hotdoc-dbus-extension, not sure why it
        was added in the first place.
      
      Using this new feature of hotdoc means we no longer need to maintain
      potentially huge lists of symbols in the markdown files.
      
      As desired by Philip, we now pass the C sources to hotdoc in the
      Makefile, which means the source list does not need updating.
      
      However, combined with smart-index, this means every public symbol
      is now exposed in the documentation.
      
      Subsequent patches should filter out potentially undesirable files
      or symbols, this requires more in-depth knowledge of the project
      than I currently possess.
      
      Signed-off-by: default avatarMathieu Duponchelle <mathieu.duponchelle@opencreed.com>
      
      Differential Revision: https://phabricator.apertis.org/D3784
      a51dcfd9
    • Mathieu Duponchelle's avatar
      git.mk: ignore files and folders generated by hotdoc. · b98de020
      Mathieu Duponchelle authored
      
      This ignores:
      
      + The hotdoc depdir folder
      + The stamp files generated by the hotdoc fragment
      + The private folder for each hotdoc project
      + The output directory for each hotdoc project
      
      Signed-off-by: default avatarMathieu Duponchelle <mathieu.duponchelle@opencreed.com>
      
      Differential Revision: https://phabricator.apertis.org/D3873
      b98de020
    • Mathieu Duponchelle's avatar
Loading