Browse Source

Basic steps to build the book

master
neauoire 3 days ago
parent
commit
f2fe1e0301
9 changed files with 183 additions and 2 deletions
  1. +1
    -0
      .gitignore
  2. +23
    -2
      README.md
  3. +11
    -0
      assets/cover.svg
  4. +20
    -0
      src/Makefile
  5. +35
    -0
      src/make.bat
  6. +52
    -0
      src/source/conf.py
  7. +4
    -0
      src/source/help.rst
  8. +29
    -0
      src/source/index.rst
  9. +8
    -0
      src/source/license.rst

+ 1
- 0
.gitignore View File

@@ -0,0 +1 @@
src/build/*

+ 23
- 2
README.md View File

@@ -11,6 +11,27 @@ An absolute and universal form of graphic expression through objective and imper

## Build

Install [Sphinx(https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html).

```
sudo pacman -S python
sudo pacman -S python-pip
sudo pip install sphinx
sudo pip install recommonmark # to parse md
```

### Build HTML version

```
cd src
make html
firefox build/html/index.html
```

### Build LaTex version

```
cd src
make latex

```
>
```

+ 11
- 0
assets/cover.svg View File

@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="background:black" width="440" height="500">
<g transform="translate(30 210)">
<g transform="rotate(-45 0 0) translate(0 0)">
<path style="fill:none;stroke:#fff;stroke-width:32;stroke-linecap:butt" d="m16,102 0,-64 64,64 0,-64 64,64 0,-64 64,64 0,-64 64,0" />
<path style="fill:none;stroke:#fff;stroke-width:1;stroke-linecap:butt" d="m0,-300 0,800 m32,-800 0,800 m32,-800 0,800 m32,-800 0,800 m32,-800 0,800 m32,-800 0,800 m32,-800 0,800 m32,-800 0,800 m48,-800 0,800" />
<path style="fill:none;stroke:#fff;stroke-width:1;stroke-linecap:butt" d="M-300,22 600,22 M-300,54 600,54 M-300,102 600,102" />
</g>
<path style="fill:none;stroke:#fff;stroke-width:1;stroke-linecap:butt" d="M-300,32 600,32 M-300,0 600,0 M-300,-14 600,-14 M-300,-46 600,-46 M-300,-59 600,-59 M-300,-91 600,-91" />
</g>
</svg>

+ 20
- 0
src/Makefile View File

@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

+ 35
- 0
src/make.bat View File

@@ -0,0 +1,35 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd

+ 52
- 0
src/source/conf.py View File

@@ -0,0 +1,52 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# 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
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

project = 'Reform Handbook'
copyright = '2020, Reform'
author = 'Reform'


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

+ 4
- 0
src/source/help.rst View File

@@ -0,0 +1,4 @@
Help
========

Some text

+ 29
- 0
src/source/index.rst View File

@@ -0,0 +1,29 @@
Reform Handbook
===============

Something else
==============

Some basic text.

print 'hello'
>> hello

Guide
^^^^^

.. toctree::
:maxdepth: 2
:caption: Contents:

license
help



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

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

+ 8
- 0
src/source/license.rst View File

@@ -0,0 +1,8 @@
license
=======
Something


contact
=======
Something else

Loading…
Cancel
Save