Lilian Besson's Web Pages - using Sphinx
Where are those pages ?
==> On http://perso.crans.org/besson/.
What do those pages contain ?
Some pages host my résumé, others are just experiments, about Sphinx and many other things. A few pages talk about some points I am interested in (GNU Nano, Sublime Text 3, Firefox, hitch-hiking, maths, Pokémon etc)...
To limit the size of this one, I used an other git repository to store the
scripts/ folder : web-sphinx-scripts.
(GNU Plot & OCaml & Python toplevel,
and also a complete Python distribution, used with
python.opt.js to embed a Python toplevel in my web pages (I know, it's useless, but so funny !).
- the reStructuredText plain text markup language, mainly, for the content of the pages,
- Jinja templates (for changing appearance of the web pages),
.static/folder, for some interactive stuff on the web-pages. See this page for some details,
- CSS in the
.static/folder, for an improved style, based on the (old) default Sphinx style,
- HTML (to include a few web components in some pages),
- Python (for Sphinx configuration,
This project use the following software:
- Python, version 2.7+ or 3.4+.
- Python Sphinx (currently v1.5+, but v1.3+ should be enough);
- GNU Make (other versions of Make should NOT work);
rst2s5, included in the docutils package, only required to build other formats, but not required for building basic HTML;
- Optional: LaTeX (
hevea) (not required for building html);
- git (but not required for building);
- rsync, for uploading the update pages online;
- GNU grep;
- GnuPG (
and the following Sphinx contrib extensions, to be installed manually :
- Optional: GnuPlot (but not GNU Octave), only for these embedded examples;
- Optional: GraphViz and Dot graph (
dot), only for these embedded examples;
- Optional: Ocaml, only for these embedded examples.
To install all these dependencies, use brew on Mac OS, or your package manager on Linux/UNIX.
This project is released under the GPLv3 license, for more details, take a look at the LICENSE file in the source.
Basically, that allow you to use all or part of the project for you own business.