xkzl / doxygen-template Goto Github PK

Example doxygen documentation website using GitLab Pages.

Learn more about GitLab Pages at https://pages.gitlab.io and the official documentation https://docs.gitlab.com/ce/user/project/pages/.

Table of Contents generated with DocToc

• GitLab CI
• Requirements
• Building locally
• GitLab User or Group Pages
• Did you fork this project?
• Troubleshooting

This project's static Pages are built by GitLab CI, following the steps defined in .gitlab-ci.yml:

image: alpine

pages:
  script:
  - apk update && apk add doxygen
  - doxygen doxygen/Doxyfile
  - mv doxygen/documentation/html/ public/
  artifacts:
    paths:
    - public
  only:
  - master

• Doxygen
• GraphViz (dot) [optionally]

If generating PDFs:

• PDF-LaTeX
• Ghostscript
• make [on *nix]

To work locally with this project, you'll have to follow the steps below:

1. Fork, clone or download this project
2. Install Doxygen
3. Generate the documentation: doxygen ./doxygen/Doxyfile

The generated HTML will be located in the location specified by the Doxyfile, in this case doxygen/documentation/html.

Read more at Doxygen's documentation.

To use this project as your user/group website, you will need one additional step: just rename your project to namespace.gitlab.io, where namespace is your username or groupname. This can be done by navigating to your project's Settings.

Read more about user/group Pages and project Pages.

If you forked this project for your own use, please go to your project's Settings and remove the forking relationship, which won't be necessary unless you want to contribute back to the upstream project.

1. CSS is missing! That means two things:

   Either that you have wrongly set up the CSS URL in your templates, or your static generator has a configuration option that needs to be explicitly set in order to serve static assets under a relative URL.