Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 910 Bytes

README.md

File metadata and controls

40 lines (26 loc) · 910 Bytes

TomoATT Documentation

This repository contains source codes of TomoATT Documentation powered by Sphinx with Pydata theme.

Build a environment

  1. Create a conda environment
conda create --name tomoatt-docs --channel conda-forge

Then activate the virtual environment

conda activate tomoatt-docs
  1. Install dependence
conda install sphinx sphinx-copybutton sphinx-design myst-nb pydata-sphinx-theme

Build the documentation

  1. Clone this repository
git clone https://github.com/MIGG-NTU/TomoATT-docs.git
cd TomoATT-docs
  1. Compile and generate documentation in HTML format
make html
  1. The generated documentation is located in the build/html/ directory and can be previewed locally by directly opening build/html/index.html with a browser.