sforman
/
Thun
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor edits.

This commit is contained in:
Simon Forman 2020-04-24 13:27:13 -07:00
parent 078f29830d
commit d089cd5d75
1 changed files with 24 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README
View File

@ -10,21 +10,22 @@
-------------------------------------------------- --------------------------------------------------
Copyright © 2014-2019 Simon Forman Copyright © 2014-2020 Simon Forman
This file is part of Thun This file is part of Thun
Thun is free software: you can redistribute it and/or modify it under the Thun is free software: you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later Foundation, either version 3 of the License, or (at your option) any
version. later version.
Thun is distributed in the hope that it will be useful, but WITHOUT ANY Thun is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
PARTICULAR PURPOSE. See the GNU General Public License for more details. FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
You should have received a copy of the GNU General Public License along with You should have received a copy of the GNU General Public License along
Thun. If not see <http://www.gnu.org/licenses/>. with Thun. If not see <http://www.gnu.org/licenses/>.
-------------------------------------------------- --------------------------------------------------
@ -57,15 +58,30 @@ Or if you have downloaded the source, from the top directory:
python ./setup.py install python ./setup.py install
Or you can run the package from the top directory. To start a crude REPL: Or you can run the package directly from the top directory.
To start a crude REPL:
python -m joy python -m joy
§.3 Documentation §.3 Documentation
§.3.1 Jupyter Notebooks
The docs/ folder contains Jupyter notebooks, ... TODO The docs/ folder contains Jupyter notebooks, ... TODO
§.3.2 Sphinx Docs
Some of the documentation is in the form of ReST files
§.3.3 Building the Docs
Building the documentation is a little tricky at the moment. It involves
a makefile that uses nbconvert to generate ReST files from some of the
notebooks, copies those to the sphinx source dir, then builds the HTML
output using sphinx.
§.4 Basics of Joy §.4 Basics of Joy