squib/docs
Andy Meneely 27b3be4744 ok last tweaks i swear 2021-07-23 11:52:13 -04:00
..
_static/css docs: provide previews of built-in layouts 2016-09-08 23:19:35 -04:00
args Documenting all the shorthands I know of 2020-11-17 22:32:12 -05:00
cli docs: add sprues for #247 2018-07-31 16:14:11 -04:00
dsl ok last tweaks i swear 2021-07-23 11:52:13 -04:00
guides Fix a few broken links in the docs (#321) 2020-10-26 10:52:54 -04:00
Makefile Begin the journey to readthedocs.org 2016-01-23 22:05:30 -05:00
README.md docs: document running your code 2019-05-22 15:07:46 -04:00
arrays.rst docs: include samples ranges and colors 2016-11-15 14:35:25 -05:00
backends.rst docs: title revisions and other rewriting 2016-04-14 11:34:10 -04:00
bleed.rst Improve bleed documentation 2019-05-28 15:02:57 -04:00
build_groups.rst import: data frames are here! 2016-12-02 00:17:57 -05:00
colors.rst Add sample for color switch in colors docs (#274) 2019-05-29 09:47:29 -04:00
conf.py drop shadows! they're a thing now. 2021-07-23 11:01:41 -04:00
config.rst woof this was a big change but ok 2020-11-17 23:40:15 -05:00
data.rst import: data frames are here! 2016-12-02 00:17:57 -05:00
help.rst Fix broken links (#291) 2019-10-21 15:57:18 -04:00
index.rst starting documenting xywh_shorthands 2020-11-17 22:22:38 -05:00
install.rst docs: update installer info 2019-05-28 15:07:24 -04:00
layouts.rst Layout multiple inheritance works with operators 2018-07-31 15:07:33 -04:00
learning.rst docs: projects using squib 2016-11-26 09:50:19 -05:00
make.bat Begin the journey to readthedocs.org 2016-01-23 22:05:30 -05:00
parameters.rst docs: cleanup of parameters page 2016-11-05 00:23:17 -04:00
server.bat feature: build groups 2016-03-13 00:38:13 -05:00
shorthands.rst make shorthands more intuitive 2020-11-24 12:16:54 -05:00
sprues.rst Flip options for sprues (#251) (#277) 2019-06-07 15:23:15 -04:00
text_feature.rst Document in the text method place 2019-10-17 12:11:06 -04:00
units.rst starting documenting xywh_shorthands 2020-11-17 22:22:38 -05:00

README.md

Building these Docs Locally

Install these:

$ pip install sphinx sphinx-autobuild sphinx_rtd_theme

To run the server:

$ cd docs
$ ./server.bat

or

$ sphinx-autobuild . _build/html

Then visit http://localhost:8000 to see the docs.