Mercurial > p > roundup > code
comparison doc/developers.txt @ 7740:67438e439da8
docs: issue2551317 add support for jinja2 customization examples
Added sphinx-tabs to doc build. This allows adding code-tabs one for
"TAL" examples and one for "Jinja2" examples in the doc.
Converted partly the "Editing multiple items in an index view"
example. Sombody who knows jinja2 better than I, and can test the
example will need to finish it.
Documented requirement and method for building docs in developers.txt.
Added requirements.pip files for pip install -r ... modules needed for
processing docs.
Fixed missing block in layout.txt that stopped tabs.css from being
loaded.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sat, 17 Feb 2024 18:56:04 -0500 |
| parents | 3134415ffb8a |
| children | a46675399a05 |
comparison
equal
deleted
inserted
replaced
| 7739:e2816259ccce | 7740:67438e439da8 |
|---|---|
| 179 | 179 |
| 180 If you set the environment variable SENDMAILDEBUG to a filename, | 180 If you set the environment variable SENDMAILDEBUG to a filename, |
| 181 roundup will write each email message that it sends to that file | 181 roundup will write each email message that it sends to that file |
| 182 instead to the internet. This environment variable is independent of | 182 instead to the internet. This environment variable is independent of |
| 183 the python -O flag. | 183 the python -O flag. |
| 184 | |
| 185 Documentation Notes | |
| 186 ------------------- | |
| 187 | |
| 188 All docs are written using sphinx. Use pip or your package manager to | |
| 189 install sphinx. In addition you will need to install a couple of | |
| 190 sphinx extensions to process the files. A requirement's file can be | |
| 191 found in docs/requirement.pip or website/www/requirements.pip. You can | |
| 192 install these requirements using ``python -m pip install -r | |
| 193 <path_to_requirements_file>``. | |
| 194 | |
| 195 The extensions sphinx-sitemap generates a sitemap when building for | |
| 196 the website. The sphinx-tabs extension generates tabs for displaying | |
| 197 code examples in both TAL and Jinja2. | |
| 198 | |
| 199 To build the documentation distributed with a Roundup release, run | |
| 200 ``python setup.py build_doc`` at the root of the source tree. To build | |
| 201 docs for the website, see the ``updating www.roundup-tracker.org`` | |
| 202 section of ``website/README.txt`` or TL;DR ``cd website/www; make | |
| 203 html``. | |
| 184 | 204 |
| 185 Testing Notes | 205 Testing Notes |
| 186 ------------- | 206 ------------- |
| 187 | 207 |
| 188 Create tests for your changes. Also run the tests in reverse to try to | 208 Create tests for your changes. Also run the tests in reverse to try to |