Commit graph

19 commits

Author SHA1 Message Date
Simon Arlott
1b81e34a55
doc: there is no _static directory 2018-08-12 09:37:50 +01:00
Simon Arlott
f2fa7bd2ab
Merge pull request #263 from anarcat/extban-doc
point users towards HELP EXTBAN for inline help
2018-08-12 09:26:58 +01:00
Antoine Beaupré
f5bd632497
point to the CMODE help page for more modes 2018-08-12 09:23:12 +01:00
Antoine Beaupré
15e0fce707
fix more headings 2018-08-12 09:23:10 +01:00
Antoine Beaupré
0f04574db1
fix two headings to be toplevel 2018-08-12 09:23:09 +01:00
Antoine Beaupré
3eea7d371e
do not hardcode theme 2018-08-12 09:22:59 +01:00
Antoine Beaupré
9546ba08e1
config.rst review 2018-08-12 09:22:58 +01:00
Antoine Beaupré
1e04a8dd8c
review commands.rst style 2018-08-12 09:22:56 +01:00
Antoine Beaupré
b12af1dbb1
fix style in ucommands.rst 2018-08-12 09:22:55 +01:00
Antoine Beaupré
e48d102ca3
fix syntax warning 2018-08-12 09:22:53 +01:00
Antoine Beaupré
316531aefb
fix ucommands.rst style 2018-08-12 09:22:50 +01:00
Antoine Beaupré
b44a51d470
review umodes.rst 2018-08-12 09:22:48 +01:00
Antoine Beaupré
90a29f9ab4
review oprivs.rst style 2018-08-12 09:22:46 +01:00
Antoine Beaupré
5d963f8352
review cmodes.rst style 2018-08-12 09:22:43 +01:00
Antoine Beaupré
4245facd2e
some styling
turn all +flags into preformatted flags, fix admonitions
2018-08-12 09:22:26 +01:00
Antoine Beaupré
a0bd1cc026
ignore build results 2018-08-12 09:20:34 +01:00
Antoine Beaupré
8a7d33db3e
fix duplicate headings, remove duplicate ToC 2018-08-12 09:20:32 +01:00
Antoine Beaupré
8380f40a78
merge two index pages 2018-08-12 09:20:20 +01:00
Antoine Beaupré
2ae078d87b
convert SGML guide to RST
the rationale behind switching away from SGML/Docbook is the following:

 * SGML is hard to edit for humans
 * the output is not much prettier
 * the toolchain is not well supported and missing from the build
 * the build is not hooked into anywhere, no automation

the reason why RST was chosen:

 * it allows for a strong structure like Docbook
 * the theme from Read The Docs is pretty
 * it also supports mobile devices
 * sphinx can easily output to PDF and ePUB formats
 * RST is plaintext that can be easily edited and diff'd
 * RST can be automatically built by ReadTheDocs and the toolchain is
   readily available
 * the output is also parsed by Github so documentation can be read
   straight from GH

the reason why Markdown was not chosen:

 * the current strong structure would be hard to replicate
 * markdown is not standardized and output varies according to the
   implementation

the docs were converted with Pandoc, using the following commands:

    mkdir oper-guide
    for source in sgml/oper-guide/*.sgml; do
        pandoc --toc -s -f docbook -t rst $source -o oper-guide/$(basename $source .sgml).rst
    done
    cd oper-guide
    sphinx-quickstart
    git add *.rst make.bat conf.py
    git add -f Makefile
    git rm -r ../sgml

[merged from d4214e9445: doc/sgml/oper-guide/config.sgml]
2018-08-12 09:15:13 +01:00