PhD code documentation

Setup

Reference repository that has been the basis of my structure

Sphinx

The code documentation was done using sphinx. Initially I planned on using doxygen but decided to shift to sphinx as it supports html, latex, and pdf generation superbly. For comparison between the two, see link. readthedocs uses sphinx.

Sphinx was setup-ed for my github Matlab code based on the following references: medium article

  1. Install sphinx

    pip install -U sphinxcontrib-matlabdomain
    
  2. Create a docs directory and cd into this directory.

    mkdir docs
    cd docs
    
  3. Setup Sphinx using command

    sphinx-quickstart
    
    Sphinx quickstart configuration
  4. Modified source/conf.py according to link. the matlabdomain extension should be added to the end.

  5. Install theme similar to readthedocs.

  6. See docstring tutorial on how to add documentation inside your code

Github

  1. Paper code and library are set up as separate repositories. To update the paper repo from the gaittoolbox repo use

    git submodule update --remote --merge
    
  2. When using the first time

    git submodule update --init --recursive
    

Github Pages

  1. Follow the instructions at link.

Maintenance

  1. For newly cloned repository, pull html code at docs/build

    cd docs/build
    git clone https://lsy3@github.com/gait-tech/gaittoolbox.git html --branch gh-pages
    
  2. Generate sphinx html using the command

    cd docs
    make html
    
  3. Commit and push gh-pages branch

OpenProject

Add the following description to each analysis. +paper revision: commit a1a1df00ff64c30b1f33065576b567ad9b0002fd (HEAD -> dev, origin/dev)

gaittools revision: commit e83c1844bc1ee0a883e02f60a8cb62406840a350 (HEAD -> lgcekf-7seg, origin/lgcekf-7seg)

exploreUNSW dataarchive: output-ckfdistv1-explore

Evernote: https://www.evernote.com/l/ARJQYOPw335Or4YirqVRSeJ80rasQ-Xbgik/

Onedrive: https://unsw-my.sharepoint.com/:f:/r/personal/z5151460_ad_unsw_edu_au/Documents/Thesis%20-%20Sparse%20Mocap/Goal01b-CKFDist/Analysis-ckfdistv1-explore-20200109?csf=1&e=xdOKKq
Avatar
Luke Sy
PhD Candidate

My research interests include state estimation, robotics, wearable sensors, machine learning, and biomedical engineering.

Related

Next
Previous