Giter VIP home page Giter VIP logo

reeborg-docs's Introduction

reeborg-docs

Documentation (Python tutorial and how to use Reeborg) in multiple languages for http://reeborg.ca/docs/en, etc.

To make a new language version

The simplest way to create a new language version is to start from an existing one (say the "en" version) and translate the .rst files one at a time.

Note that you may need to install https://pypi.python.org/pypi/sphinxcontrib-inlinesyntaxhighlight

You may get an error about not being able to import module reeborg_xx in help.rst. You can just ignore such error.

Editing the relevant make file

You will need to edit the make.bat or the Makefile (depending on your operating system) to replace "en" by the two-letter code of your language for the following five lines in make.bat:

  • set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees_en %SPHINXOPTS%

  • rd /s /q en

  • rd /s /q doctrees_en

  • %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/en

  • echo.Build finished. The HTML pages are in %BUILDDIR%/en.

or (and this is untested) the following ones in Makefile:

  • ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees_en $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

  • $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/en

  • @echo "Build finished. The HTML pages are in $(BUILDDIR)/en."

Note that, in both cases, BUILDDIR=../../_build instead of BUILDDIR=_build

Editing the relevant conf.py file

to do

Editing the relevant theme files

to do

Optional: create new images

to do

reeborg-docs's People

Contributors

aroberge avatar xwmooc-net avatar annobis avatar hadi-f90 avatar

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.