Commit 63f773bf authored by Protocole's avatar Protocole
Browse files

Merge branch '277-update-the-default-folder-for-pages' into 'latest'

Resolve "Update the default folder for pages"

Closes #277

See merge request r2devops/hub!139
parents f51f699c 60abab8e
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ code using [apiDoc](https://www.apidocjs.com/){:target="_blank"}.
| ---- | ----------- | ------- |
| `APIDOC_VERSION` <img width=250/> | Version of apiDoc to use <img width=400/> | `0.24.0` |
| `APIDOC_CONFIG_PATH` | Path to config file or to directory containing config file (apidoc.json or apidoc.config.js) | `.` |
| `APIDOC_OUTPUT_PATH` | Output directory path | `/documentation_build` |
| `APIDOC_OUTPUT_PATH` | Output directory path | `website_build/` |
| `APIDOC_TEMPLATE_PATH` | Path to template folder | `/usr/lib/node_modules/apidoc/template/` |

### Artifacts
+1 −1
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ apidoc:
  stage: build
  variables:
    APIDOC_CONFIG_PATH: '.'
    APIDOC_OUTPUT_PATH: 'documentation_build/'
    APIDOC_OUTPUT_PATH: 'website_build/'
    APIDOC_TEMPLATE_PATH: '/usr/local/lib/node_modules/apidoc/template/'
    APIDOC_VERSION: '0.24.0'
  script:
+1 −0
Original line number Diff line number Diff line
* Update default output location from `documentation_build/` to `website_build/`
+1 −1
Original line number Diff line number Diff line
@@ -42,7 +42,7 @@ Other languages can be supported with additional code.
| `DOXYGEN_GENERATE_LATEX`               | Set to YES if you want to generate LaTeX documentation | `YES`|
| `DOXYGEN_LATEX_OUTPUT`               | The path of your LaTeX documentation generated| `latex/`|
| `DOXYGEN_GENERATE_HTML`               | Set to YES if you want to generate HTML documentation | `YES`|
| `DOXYGEN_HTML_OUTPUT`               | The path of your LaTeX documentation generated| `documentation_build/`|
| `DOXYGEN_HTML_OUTPUT`               | The path of your LaTeX documentation generated| `website_build/`|
| `DOXYGEN_HTML_EXTRA_STYLESHEET`               | The path of additional user-defined cascading style sheets [CSS](https://www.w3schools.com/css/)| ` `|
| `DOXYGEN_RECURSIVE`               | Specify whether or not subdirectories should be searched for input files as well| `NO`|
| `DOXYGEN_EXCLUDE`               | Specify files and/or directories that should be excluded from the INPUT source files| ` `|
+1 −1
Original line number Diff line number Diff line
@@ -48,7 +48,7 @@ doxygen:
      # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it.
      # The default directory is: html.
      # This tag requires that the tag GENERATE_HTML is set to YES.
      DOXYGEN_HTML_OUTPUT: "documentation_build/"
      DOXYGEN_HTML_OUTPUT: "website_build/"

      # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined cascading style sheets that are included after the standard style sheets created by doxygen.
      # Using this option one can overrule certain style aspects. This is preferred over using HTML_STYLESHEET since it does not replace the standard style sheet and is therefore more robust against future updates.
Loading