File tree Expand file tree Collapse file tree
Open diff view settings
Expand file tree Collapse file tree
Open diff view settings
Original file line number Diff line number Diff line change @@ -66,10 +66,39 @@ Afterwards you can point your browser to `bpython/doc/source/index.html`. Don't
6666to recreate the HTML after you make changes.
6767
6868
69- To hack on the site:
70- --------------------
69+ To hack on the site or theme
70+ ----------------------------
7171
72- TODO
72+ The site (and it's theme as well) is stored in a separate repository and built using
73+ pelican. To start hacking on the site you need to start out with a checkout and
74+ probably a virtual environment:
75+
76+ .. code-block :: bash
77+
78+ $ virtualenv bpython-site-dev
79+ $ source bpython-site-dev/bin/activate
80+ $ pip install pelican
81+
82+ Fork bsite and bsite-theme in the GitHub web interface, then clone the
83+ repositories:
84+
85+ .. code-block :: bash
86+
87+ $ git clone git@github.com:YOUR_GITHUB_USERNAME/bsite.git
88+ $ git clone git@github.com:YOUR_GITHUB_USERNAME/bsite-theme.git
89+
90+ Next you can fiddle around in the source files. If you want to build the site
91+ you activate your virtualenv and tell pelican to generate the site with the
92+ included configuration file.
93+
94+ .. code-block :: bash
95+
96+ $ source bpython-site-dev/bin/activate
97+ $ cd bsite # if you want to fiddle on the text of the site otherwise go into bsite-theme
98+ $ pelican -t ../bsite-theme -s pelicanconf.py # if you checked out the theme in a different place, use that path
99+
100+ After this you can open the `output/index.html ` in your favourite browser and see
101+ if your changes had an effect.
73102
74103.. _GitHub issue tracker : https://github.com/bpython/bpython/issues
75104.. _bite-size : https://github.com/bpython/bpython/labels/bitesize
You can’t perform that action at this time.
0 commit comments