@@ -15,27 +15,22 @@ more details).
1515Development
1616~~~~~~~~~~~
1717
18- This site uses wok _. To install wok and other dependencies, run
19- ``pip install -r requirements.txt ``. wok currently only works with Python 2.7.
18+ This site uses django-amber _. To install django-amber and other dependencies,
19+ run ``pip install -r requirements.txt ``. django-amber is only known to work
20+ with Python 3.5.
2021
21- wok builds the site by assembling several components:
22+ django-amber builds the site by assembling several components:
2223
23- * Pages are found in ``content/ ``. Pages may be HTML, Markdown _ or reStrcturedText _, and contain some YAML metadata.
24- * Statuc files are found in ``media/ ``.
25- * The various jinja2 _ templates for pages can be found in ``templates/ ``.
24+ * Pages are found in ``content/ ``. Pages may be HTML or Markdown _, and contain
25+ some YAML metadata.
26+ * Static files are found in ``media/ ``.
27+ * The various Django templates for pages can be found in ``templates/ ``.
2628
27- To build the site, run ``make build ``. This pulls together all the components
28- into a set of HTML files in ``output/ ``.
29+ To build the site, run ``python manage.py buildsite ``. This pulls together all
30+ the components into a set of HTML files in ``output/ ``.
2931
30- Windows users: you need to run the (extensionless) ``wok `` script in
31- ``c:\pythonxx\scripts ``. e.g. ``py -2 c:\python27\scripts\wok ``.
32-
33- Alternatively, if you run ``make serve ``, wok will build the site, serve the
34- built site on port 8000, and watch for changes.
35-
36- Windows users: you ned to run the (extensionless) ``work `` script with the
37- ``--serve `` parameter in ``c:\pythonxx\scripts ``. e.g.
38- ``py -2 c:\python27\scripts\wok --serve ``.
32+ Alternatively, if you run ``python manage.py serve ``, django-amber will build
33+ the site, serve the built site on port 8000, and watch for changes.
3934
4035You can test that the site contains no broken links and that various common
4136mis-spellings are caught correctly (hint, it's a "BBC micro:bit" for example)
@@ -71,19 +66,18 @@ works:
7166 the ISO 639-1 language code. They contain the content for this website in
7267 the langauge referenced by the language code in the name of the directory.
7368 For example, the English content is found in the ``content/en/ `` directory
74- whereas the German content is in ``content/de/ ``. You must make sure that
75- the ``type `` field in the YAML header for the content is set to the correct
76- page template for the language.
69+ whereas the German content is in ``content/de/ ``.
7770* If in doubt, just look at what happens in the English version of the site and
7871 adapt to the desired language.
7972
8073Deployment
8174~~~~~~~~~~
8275
8376The site is hosted as a Project Page on GitHub Pages, and so it is the
84- ``gh-pages `` branch of the repository that gets served. wok generates the site
85- in the ``output/ `` directory, and Travis is configured to push any changes to
86- the ``output/ `` directory to this branch. See ``deploy.sh `` for details.
77+ ``gh-pages `` branch of the repository that gets served. django-amber generates
78+ the site in the ``output/ `` directory, and Travis is configured to push any
79+ changes to the ``output/ `` directory to this branch. See ``deploy.sh `` for
80+ details.
8781
8882This should be done automatically by Travis after it has built the ``master ``
8983branch, but in case this does not happen, somebody with commit access to the
@@ -99,9 +93,8 @@ for the project.
9993Note: this is tied to a single user on GitHub, however any other GitHub user
10094with valid permissions can replace the key on Travis.
10195
102- .. _ wok : http ://wok.mythmon. com/
96+ .. _ django-amber : https ://github. com/inglesp/django-amber
10397.. _Markdown : https://pythonhosted.org/Markdown/
10498.. _reStructuredText : http://docutils.sourceforge.net/rst.html
105- .. _jinja2 : http://jinja.pocoo.org/
10699.. _issue : https://github.com/python/pythonineducation.org/issues
107100.. _CONTRIBUTING.rst : ./CONTRIBUTING.rst
0 commit comments