-
Notifications
You must be signed in to change notification settings - Fork 106
/
make_www_doc.py
35 lines (29 loc) · 1.21 KB
/
make_www_doc.py
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
"""
This script takes the python documentation files, adds a YAML header with a
custom title, strips the first two lines of the file, and outputs a new file
in doc/pages/mydoc/pydoc.
"""
import os
import re
pydocfiles = os.listdir('.')
reh1 = re.compile(r'\A# (.*?)\n', re.DOTALL)
for fn in pydocfiles:
name, ext = os.path.splitext(fn)
if ext == '.md':
with open(fn, 'r') as mdfile:
line = mdfile.readline()
title = reh1.search(line).group(1)
mdfile.readline()
doc = mdfile.read()
doc = doc.replace('# ', '## ')
string = ('---\n' + 'title: ' + title + '\n' +
'keywords: spherical harmonics software package, ' +
'spherical harmonic transform, legendre functions, ' +
'multitaper spectral analysis, Python, ' +
'gravity, magnetic field\n' + 'sidebar: mydoc_sidebar\n' +
'permalink: ' + name + '.html\n' + 'summary:\n' +
'tags: [python]\n' + 'toc: false\n' + 'editdoc: pydoc\n' +
'---\n\n' + doc)
with open('../../docs/pages/mydoc/pydoc/' + name +
'.md', 'w') as www:
www.write(string)