Skip to content

Repository files navigation

Building the documentation

  1. Install sphinx (suggestion: Use a virtual environment)

    python -m venv larcc-docs-env
    source larcc-docs-env/bin/activate
    pip install sphinx sphinx-rtd-theme sphinx-tabs
  2. Build the documentation. This will create the folder _build inside the project's root folder.

    cd larcc-docs
    # Note you can use other options besides "html" here (e.g. "latex").
    # Simply run "make" to see all available options.
    make html
  3. Access the index.html file inside larcc-docs/_build/html

About

University of Louisville Research Computing User Documentation

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages