Lilian Besson’s Web Pages - using Sphinx
Currently this project is in version 3.0, public release! I recently switched to a much cleaner theme, based on alabaster, the new Sphinx’s default theme, and nicer fonts (in Dec 2017).
Where are those pages ?
==> On http://perso.crans.org/besson/.
- :gb:/:us: in English:
fr: in French:
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.
- the reStructuredText plain text markup language, mainly, for the content of the pages,
- Jinja templates (for changing appearance of the web pages),
- CSS in the `.static/ <.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, `conf.py <conf.py>`__ file).
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);
- rst2pdf, rst2html, rst2s5, included in the docutils package, only required to build other formats, but not required for building basic HTML;
- Optional: LaTeX (pdflatex, and hevea) (not required for building html);
- git (but not required for building);
- rsync, for uploading the update pages online;
- GNU grep;
- GnuPG (gpg);
- and the following Sphinx contrib extensions, to be installed manually :
- these Python packages, from PyPI: ansicolortags, sphinx_pyreverse, sphinx_git, sphinx_tabs. Install them with sudo pip install ansicolortags sphinx_pyreverse sphinx_git sphinx_tabs;
- 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. © Lilian Besson, 2012-2018.
Basically, that allow you to use all or part of the project for you own business.