How to Contribute

Install Documentation

# download cWB Documentation from GIT Repository
# The suggested local directory where to download the repository is $HOME/git/cWB

  cd $HOME/git/cWB

# PUBLIC git repository

  git clone https://gitlab.com/gwburst/documentation.git

# LVK git repository

  git clone git@git.ligo.org:cWB/documentation.git

Documentation uses doxygen to generate reference guide for cWB library and cWB config. The instructions to install the library and config are here.

Install Auxiliary Libraries

The cWB documentation is written in reStructuredText Format and uses Sphinx, Read the Docs Theme, and sphinx-multiversion for versioned builds.

To install the auxiliary libraries in the local user account do:

# installation of packages used for cwb documentation
# packages are installed into a virtual environment ~/virtualenv/cwb_docs

# create the virtual environment

python3 -m venv ~/virtualenv/cwb_docs

# activate the virtual environment

source ~/virtualenv/cwb_docs/bin/activate

# install packages

pip3 install -r requirements.txt

# the requirements.txt file is in the documentation git repository:

sphinx>=7.4,<8
sphinx-multiversion>=0.2.4
sphinx-rtd-theme>=3.0
sphinxcontrib-programoutput>=0.17
sphinxcontrib-contentui>=0.2.5
sphinxcontrib-doxylink>=1.12
matplotlib>=3.7


# to update packages

pip3 install -r requirements.txt -U


# setting (for bash shell)

source ~/virtualenv/cwb_docs/bin/activate


# setting (for tcsh shell)

source ~/virtualenv/cwb_docs/bin/activate.csh

Generate Documentation

# generate cWB config and library reference guides with Doxygen

make doxygen

# generate cWB documentation

make html

# generate cWB command man

make man

# the man1 files are copied into library $HOME_WAT/man directory

# to get the online command help do (Ex):

    man cwb_inet

Public Documentation

cWB

For more details on building and maintaining the documentation under public GitLab project pages, see