BCDA-APS / gemviz

Data visualization for tiled
https://bcda-aps.github.io/gemviz/
Other
4 stars 0 forks source link

add documentation #97

Closed prjemian closed 1 year ago

prjemian commented 1 year ago

Start the Sphinx documentation for this package.

prjemian commented 1 year ago

@rodolakis This is a good issue to work on together.

rodolakis commented 1 year ago
[onyxia ~/src] $ become_bluesky
(bluesky_2023_2) [onyxia ~/src]$ cd gemviz
(bluesky_2023_2) [onyxia ~/src/gemviz]$ mkdir docs
(bluesky_2023_2) [onyxia ~/src/gemviz]$ cd docs
(bluesky_2023_2) [onyxia ~/src/gemviz/docs]$ sphinx-quickstart
> Separate source and build directories (y/n) [n]: y
> Project name: gemviz
> Author name(s): Fanny Rodolakis, Pete Jemian, Ollivier Gassant
> Project release []: 0
> Project language [en]: 

Creating file /home/RODOLAKIS/src/gemviz/docs/source/conf.py.
Creating file /home/RODOLAKIS/src/gemviz/docs/source/index.rst.
Creating file /home/RODOLAKIS/src/gemviz/docs/Makefile.
Creating file /home/RODOLAKIS/src/gemviz/docs/make.bat.

Finished: An initial directory structure has been created.

(bluesky_2023_2) [onyxia ~/src/gemviz/docs]$ make html

Running Sphinx v6.2.1
making output directory... done
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 1 source files that are out of date
updating environment: [new config] 1 added, 0 changed, 0 removed
reading sources... [100%] index                                                                                                                  
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index                                                                                                                   
generating indices... genindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in build/html.