blob: 7a82d6b490e08c41bbdba62348efb4beb86cdeea (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
Poseidoc
========
A documentation system built on Doxygen and Pandoc
Overview
--------
## For now
- Takes Doxygen-generated XML input
- Outputs Pandoc's JSON AST
## In the future
- Will generate the Doxyfile and the XML files for you
- Will generate the output directly
- HTML is a priority
- Then PDF / LaTeX
- If the project is well designed, other outputs should be supported out of
the box thanks to Pandoc
- Per-project TOML configuration
Quick Start
-----------
- Have a documented project
- Generate a Doxyfile that outputs XML and **without** Markdown support (for
example with `doxywizard`)
- `cargo run -- <xml file> | pandoc --from json --to html --standalone
--self-contained --toc --css <your css here> --output <output file>.html`
Goals
-----
- It needs to be simple and very easy to setup
- It needs to be configurable by project
- It should encourage people to write documentation
- It should encourage people to read documentation
- Warnings? Maybe?
### Interface design goals
- It should be beautiful
- It should be easy to get wanted information from a glance
- It should be accessible
### Technical goals
- Little to no JavaScript
- The generated markup must be simple and semantic
- Sensible defaults for Doxygen and Pandoc
- But both Doxygen and Pandoc must be completely configurable
|
