olddoc.git  about / heads / tags
olddoc - old-fashioned RDoc generator(s)
blob e2fdedb6efe6219715aa9c8e027aadabb962acd1 773 bytes (raw)
$ git show v1.2.0:Documentation/olddoc.5.txt	# shows this blob on the CLI

 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
 
% olddoc(1) olddoc user manual

# NAME

.olddoc.yml - olddoc config file format

# SYNOPSIS

A YAML file in the top-level project directory named ".olddoc.yml"

# DESCRIPTION

As olddoc favors consistency over configuration, there is minimal
configuration to deal with.

# KEYS

`rdoc_url`, `cgit_url`, and `nntp_url` should be obvious

`merge_html` is a key-value mapping of (empty) RDoc source files to an
HTML file that will be merged into RDoc after-the-fact.  It is useful
for merging non-RDoc generated HTML into the project.

`ml_url` is the mailing list archive location.
`public_email` is the email address of a publically archived mailing list
at `ml_url`

As of olddoc 1.2.0, `ml_url` and `nntp_url` may be YAML arrays
with multiple URLs.

# SEE ALSO

olddoc(1)

git clone https://80x24.org/olddoc.git