Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • mHM mHM
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 50
    • Issues 50
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 9
    • Merge requests 9
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Container Registry
  • Monitor
    • Monitor
    • Metrics
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • mhmmhm
  • mHMmHM
  • Merge requests
  • !44

Online Documentation with GitLab pages

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Sebastian Müller requested to merge muellese/mhm:doc_update into develop Sep 13, 2020
  • Overview 0
  • Commits 23
  • Pipelines 9
  • Changes 56

This MR enables the online documentation of mHM based on the present Doxgen documentation:

  • switch to select the documented branch (master/develop/v5.11/...) was added to the webpage to switch between versions of mHM.
  • the documentation can later be accessed by: https://mhm.pages.ufz.de/mhm
  • by default, the documentation will point to the master version (which is not present yet)
  • test version can be accessed by: https://muellese.pages.ufz.de/mhm/doc_update (you can only switch to develop there, since master is not present)
  • the lib folder was excluded in the documentation, since it will get its own one
  • the documentation will be build automatically during CI runs in the build stage
  • along with the online documentation, a pdf version will be build and provided as an artifact by the Gitlab-runner
Edited Sep 13, 2020 by Sebastian Müller
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: doc_update