Giter Club home page Giter Club logo

enigmabox-documentation's Introduction

Enigmabox Handbook

Setup Instructions

The Enigmabox Handbook uses Sphinx to manage the documentation and output it to various formats. Pages are written in human-readable ReStructured Text format.

Prerequisites

Sphinx requires Python, which is already installed if you are running OS X. You can confirm in a Terminal window by executing the python command without any parameters. It should load up and tell you which version you have installed. If you're not on 2.7+, go ahead and install 2.7.2 from http://python.org/download/releases/2.7.2/

Installation

Assuming you want to generate the german (de) manual:

  1. Install easy_install
  2. easy_install "sphinx==1.2.3"
  3. cd de
  4. make html

Editing and Creating Documentation

All of the source files exist under source/ in the corresponding language directory and is where you will add new documentation or modify existing documentation.

So where's the HTML?

Obviously, the HTML documentation is what we care most about, as it is the primary documentation that our users encounter. Since revisions to the built files are not of value, they are not under source control. This also allows you to regenerate as necessary if you want to "preview" your work. Generating the HTML is very simple. From the root directory of your user guide repo fork issue the command you used at the end of the installation instructions:

make html

You will see it do a whiz-bang compilation, at which point the fully rendered user guide and images will be in build/html/. After the HTML has been built, each successive build will only rebuild files that have changed, saving considerable time. If for any reason you want to "reset" your build files, simply delete the build folder's contents and rebuild.

enigmabox-documentation's People

Contributors

enigmagroup avatar cypherpunk avatar

Stargazers

LZ91X  avatar

Watchers

James Cloos avatar  avatar

enigmabox-documentation's Issues

Duzen oder Siezen?

In verschiedenen Teilen der Dokumentation Duzen Sie den Leser - in anderen Siezen sie ihn.
Sie sollten dies Vereinheitlichen und evt. in diesem Repo (z.B. in der CONTRIBUTING.md) einen Hinweis dazu hinzufügen.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.