ENH: Add sphinx Makefile and conf.py - Githubissues

westurner / wiki

https://westurner.org/wiki

https://westurner.org/wiki

45 stars 19 forks source link

ENH: Add sphinx Makefile and conf.py #3

Closed westurner closed 9 years ago

westurner commented 9 years ago

Challenges

github wiki only recognizes pages in the first-level directory
github ReStructuredText wiki pages default to .rest extensions
Sphinx only supports one file extension (.rst | .rest | .md)
Sphinx markdown support requires pandoc conversion from markdown
Inter-wiki path links may not be path/ portable

Benefits

Responsive (full window) design
Open in new page
Custom HTML
Analytics

Todo

[x] add conf.py

https://github.com/westurner/dotfiles/blob/master/docs/conf.py
[x] merge in Makefile (requirements: make html gh-pages push)

https://github.com/westurner/dotfiles/blob/master/docs/Makefile
[x] overwrite current gh-pages branch (redirect to westurner/wiki/wiki) with make html (_build/html) [e.g. with ghp-import]

See: https://github.com/westurner/westurner.github.io/issues/3

westurner commented 9 years ago

https://westurner.github.io/wiki/