Debian Codegraph @

docs/documentation_readme.txt

raw
1 The RAW documentation is now formatted for sphinx. This requires sphinx be
2 installed, along with appropriate themes (alabaster and read-the-docs). To do so:
3 conda install sphinx sphinx_rtd_theme
4
5 To build html, be in the top level (docs) folder and use:
6 make html
7
8 To build pdfs, be in the top level (docs) folder and use:
9 make latexpdf
10
11 On windows without make you can use:
12 sphinx-build -b html source build\html
13
14 It is recommended that you first delete any old files in the build folder, as some
15 changes may not propagate when rebuilding. Do this with a:
16 make clean
17
18 When releasing new documentation, update the version number in the conf.py file.
19
20 Useful site for embedding youtube videos in a mobile friendly way:
21 https://embedresponsively.com/?
22
23 For video tutorials, intro/outro:
24 Hello and welcome to this tutorial for bioxtas raw. In this tutorial you will learn how to . . . .
25
26 With that, that’s the end of the tutorial. You should now know how too . . . .