diff options
| author | rsiddharth <rsd@gnu.org> | 2016-05-21 21:23:11 +0000 |
|---|---|---|
| committer | rsiddharth <rsd@gnu.org> | 2016-05-21 21:23:11 +0000 |
| commit | a474c4a99b162d5547d40f09d19d8e44d29e90de (patch) | |
| tree | 91e1c30d6603e847758fd2e9a35dd759f8127bbb | |
| parent | b84818ce500fc5a015cc4e9abe5e2703057f254f (diff) | |
docs: re-structure LP schedule page.
| -rw-r--r-- | docs/schedule/index.rst | 38 | ||||
| -rw-r--r-- | docs/speakers/index.rst | 2 | ||||
| -rw-r--r-- | lpschedule_generator/_version.py | 2 |
3 files changed, 25 insertions, 17 deletions
diff --git a/docs/schedule/index.rst b/docs/schedule/index.rst index 3d5ed33..858c93f 100644 --- a/docs/schedule/index.rst +++ b/docs/schedule/index.rst @@ -3,21 +3,10 @@ LP schedule ----------- -.. highlight:: bash - -LP schedule usage -~~~~~~~~~~~~~~~~~ -:: - - $ lps_gen -s path/to/lp-sch.jinja2 path/to/lp-sch.md > path/to/program-schedule.html - -or:: - - $ lps_gen --schedule path/to/lp-schedule.jinja2 path/to/lp-sch.md > path/to/program-schedule.html +.. highlight:: text - -LP schedule markdown structure -`````````````````````````````` +LP schedule Markdown structure +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Overall structure:: @@ -167,8 +156,21 @@ beginning of the markdown document: Sessions only sample: https://notabug.org/rsd/lpschedule-generator/raw/dev/tests/files/lp-sch-sessions-only.md -LP schedule iCal export -~~~~~~~~~~~~~~~~~~~~~~~ +.. highlight:: bash + +Generate HTML from Markdown +~~~~~~~~~~~~~~~~~~~~~~~~~~~ +:: + + $ lps_gen -s path/to/lp-sch.jinja2 path/to/lp-sch.md > path/to/program-schedule.html + +or:: + + $ lps_gen --schedule path/to/lp-schedule.jinja2 path/to/lp-sch.md > path/to/program-schedule.html + + +iCal export +~~~~~~~~~~~ The ``--ical`` switch enables iCal export while generating LP schedule:: @@ -177,3 +179,7 @@ schedule:: The year of the conference must be given as an argument to the ``--ical`` switch. + +If you run into issues, ask for :ref:`help <lps-doc-sec-help>`. + +Next, go to the :ref:`lps-doc-sec-speakers` section. diff --git a/docs/speakers/index.rst b/docs/speakers/index.rst index b67908f..8bc28eb 100644 --- a/docs/speakers/index.rst +++ b/docs/speakers/index.rst @@ -1,3 +1,5 @@ +.. _lps-doc-sec-speakers: + LP speakers ----------- diff --git a/lpschedule_generator/_version.py b/lpschedule_generator/_version.py index 8de7be0..5677f6f 100644 --- a/lpschedule_generator/_version.py +++ b/lpschedule_generator/_version.py @@ -18,4 +18,4 @@ # along with lpschedule-generator (see COPYING). If not, see # <http://www.gnu.org/licenses/>. -__version__ = u'0.6.0.dev2' +__version__ = u'0.6.0.dev3' |