Skip to content

Commit

Permalink
fix(docs): generate PDF docs from readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
dtinth committed Mar 10, 2015
1 parent 53f854c commit ff33aef
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 12 deletions.
4 changes: 4 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ indent_style = space
indent_size = 2
max_line_length = 80

[*.py]
indent_style = space
indent_size = 4

[Makefile]
indent_style = tab
indent_size = 4
19 changes: 9 additions & 10 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,19 @@
Welcome to Bemuse's documentation!
==================================

Contents:
Bemuse is a BMS player with a gameplay similar to Lunatic Rave 2.

Bemuse is web-based, which means that you don't have to download any special
software to play this game; simply use your web browser.

Bemuse is built on new, cutting-edge HTML5 technologies.
It does not require any plugin (like Flash or Unity Web Player).
This game can be played on browsers that implement these technologies
(such as Firefox, Google Chrome, and Safari).

.. toctree::
:maxdepth: 2

bms-extensions
developers/README



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

23 changes: 21 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,22 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import os
import sys

# Monkey-patch Sphinx to use XeTeX
from os import path
from sphinx.builders import latex

class XeLaTeXBuilder(latex.LaTeXBuilder):
def finish(self):
super(XeLaTeXBuilder, self).finish()
makefile_name = path.join(self.outdir, 'Makefile')
with open(makefile_name, 'r') as f: makefile = f.read()
makefile = makefile.replace('pdflatex', 'xelatex')
with open(makefile_name, 'w') as f: f.write(makefile)

latex.LaTeXBuilder = XeLaTeXBuilder

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
Expand Down Expand Up @@ -194,14 +208,19 @@

# Additional stuff for the LaTeX preamble.
#'preamble': '',
'inputenc': '',
'utf8extra': '',
'preamble': '''
\usepackage{fontspec}
''',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('README', 'Bemuse.tex', u'Bemuse Documentation',
u'The BEAT☆MUSIC☆SEQUENCE team', 'manual'),
u'The Bemuse team', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
Expand Down
1 change: 1 addition & 0 deletions docs/developers/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This page describes how to setup the project on your computer
for local development.

.. contents::
:local:


Prerequisites
Expand Down
2 changes: 2 additions & 0 deletions docs/developers/skinning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ To make it easy to adjust the gameplay screen's appearance,
the *skin* is not built into the game's source code.

.. contents::
:local:


Location
--------
Expand Down

0 comments on commit ff33aef

Please sign in to comment.