Devdocs

Service to host internal documentation for code under development.

DevDocs

This guide goes over hosting internal to ORNL documentation using ExCL’s devdocs VM. For an example of a project which uses devdocs, see Hunter and Hunter Documentation (Source).

The documentation for hunter is built with GitLab-CI. Here are the relevant lines in .gitlab-ci.yml.

stages:
    - docs
    - deploy_docs

before_script:
    - source /auto/ciscratch/conda/etc/profile.d/conda.sh
    - conda env create --force -p ./envs -f environment.yml
    - conda activate ./envs

docs-job:
    tags: [devdocs]
    stage: docs
    script:
        - cd docs
        - pip install sphinx sphinx-rtd-theme sphinx-serve recommonmark myst_parser sphinx-autoapi
        - make html
    artifacts:
        paths:
            - docs/_build/html
  
.deploy_docs_common:
    tags: [devdocs]
    stage: deploy_docs
    needs: [docs-job]
    script:
        - rsync -a --delete docs/_build/html/ ~/www/brisbane/hunter

deploy_docs-job:
    extends: .deploy_docs_common
    only:
        refs:
            - develop
  
deploy_docs_manual-job:
    extends: .deploy_docs_common
    when: manual

Request a DevDocs Site

If you would like to host your project’s internal documentation on ExCL, please email [e-mail] with the following information and we can help you get started with a DevDocs subdirectory and the DevDocs GitLab Runner.

• URL

• Runner Registration Token

• Project Name (This will be your DevDocs subdirectory)