summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorrsiddharth <rsd@gnu.org>2016-05-26 19:00:04 +0000
committerrsiddharth <rsd@gnu.org>2016-05-26 19:00:04 +0000
commit9375fb32be5bde81ba3a2ce807840570107c7284 (patch)
tree9ea71e37a8ca30f34fa303a448f5f6dbb4a80a2a
parenta474c4a99b162d5547d40f09d19d8e44d29e90de (diff)
docs: reorganized lp speakers.
-rw-r--r--docs/general/index.rst2
-rw-r--r--docs/speakers/index.rst28
2 files changed, 18 insertions, 12 deletions
diff --git a/docs/general/index.rst b/docs/general/index.rst
index 6b56f63..5974f5d 100644
--- a/docs/general/index.rst
+++ b/docs/general/index.rst
@@ -1,3 +1,5 @@
+.. _lps-doc-sec-general:
+
General
-------
diff --git a/docs/speakers/index.rst b/docs/speakers/index.rst
index 8bc28eb..f98dbdb 100644
--- a/docs/speakers/index.rst
+++ b/docs/speakers/index.rst
@@ -3,18 +3,8 @@
LP speakers
-----------
-LP speakers usage
-~~~~~~~~~~~~~~~~~
-::
-
- $ lps_gen -sp path/to/lp-speakers.jinja2 path/to/lp-speakers.md > path/to/speakers-content.html
-
-or::
-
- $ lps_gen --speakers path/to/lp-speakers.jinja2 path/to/lp-speakers.md > path/to/speakers-content.html
-
-LP speakers markdown structure
-``````````````````````````````
+Markdown structure
+~~~~~~~~~~~~~~~~~~
::
@@ -68,3 +58,17 @@ speaker' name is "John Hacker", the ID for this speaker will be
- The IDs are transliterated to ASCII; if a speaker' name is "John
HÖcker", the ID for this speaker will be ``hacker``.
+
+Generate HTML from Markdown
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+::
+
+ $ lps_gen -sp path/to/lp-speakers.jinja2 path/to/lp-speakers.md > path/to/speakers-content.html
+
+or::
+
+ $ lps_gen --speakers path/to/lp-speakers.jinja2 path/to/lp-speakers.md > path/to/speakers-content.html
+
+If you run into issues, ask for :ref:`help <lps-doc-sec-help>`.
+
+Next, you might want to look at the :ref:`lps-doc-sec-schedule` section or the :ref:`lps-doc-sec-general` section.