`Lilian Besson `__\ ’s Web Pages - using Sphinx
===============================================================================
`My web pages `__ are currently
generated with `Sphinx Doc `__ (*v1.6+*).
|Website https://perso.crans.org/besson/| |Made with Python v3.6+| |Made
with Sphinx v1.6+|
I have been using `Sphinx `__ `since
2012 `__,
and I like it very much!
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).
|Maintained? Yes!| |Ask Me Anything!|
Where are those pages ?
-----------------------
⟹ On https://perso.crans.org/besson/. |Website perso.crans.org|
Demos
-----
- 🇬🇧 in English: |Screenshot demo of my web pages in English
(1/2)|
- 🇫🇷 in French: |Screenshot demo of my web pages in French (2/2)|
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)…
Other repository
----------------
To limit the size of this one, I used an other git repository to store
the ``scripts/`` folder :
`web-sphinx-scripts `__.
This second repository mainly hosts some Javascript scripts (GNU Plot &
OCaml & Python toplevel, ``shortcuts.js``, etc), 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 !).
--------------
Author
~~~~~~
© `Lilian Besson `__,
`2011-2017 `__.
Languages
~~~~~~~~~
- the `reStructuredText `__
plain text markup language, mainly, for the content of the pages,
- `Jinja `__
`templates <.templates/>`__ (for changing appearance of the web
pages),
- `Javascript `__ in the
```.static/`` <.static/>`__ folder, for some interactive stuff on the
web-pages. See `this page for some
details `__,
- `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`` `__ file).
--------------
Requirements ?
--------------
This project use the following software:
- `Python `__, version
`2.7+ `__ or
`3.4+ `__. |PyPI pyversions|
- `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 `__ (now living on `this GitHub repo `_), to
be installed manually :
- `autorun `__;
- `bitbucket `__;
- `cheeseshop `__;
- `gnuplot `__;
- `youtube `__;
- note: there are bugs in each of these extensions, that were written for Python 2 or previous versions of Sphinx. I know know almost by memory how to fixes these bugs, but I don't have the energy of trying again to submit tickets and pull-requests to `the new repository `_. I had tickets opened on the old bitbucket repository, and didn't receive any feedback in two to four years. Basically, what I do everytime I have to install the dependencies to build my website, for instance on a new laptop, is to clone the repository, install them with a few ``sudo python3 setup.py install`` ran in the folders of the desired extensions. Then I try to compile the website, and everytime a Python exception occurs in the code of an extension, I manually edit the file in /usr/local/lib/python3.6/dist-packages/sphinxcontrib_XXX/XXX/XXX.py. It's durty, but simple.
- 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.
License |GPLv3 license|
-----------------------
This project is released under the **GPLv3 license**, for more details,
take a look at the `LICENSE
file `__ in the source. ©
Lilian Besson, 2012-2024.
*Basically, that allows you to use all or part of the project for you own business.*
|ForTheBadge built-with-love| |Analytics|
|ForTheBadge uses-badges| |ForTheBadge uses-git| |ForTheBadge uses-html|
|ForTheBadge uses-css| |ForTheBadge uses-js|
.. |Website https://perso.crans.org/besson/| image:: https://img.shields.io/website-up-down-green-red/http/perso.crans.org.svg
:target: https://perso.crans.org/besson/
.. |Made with Python v3.6+| image:: https://img.shields.io/badge/Made%20with-Python-1f425f.svg
:target: https://www.python.org/
.. |Made with Sphinx v1.6+| image:: https://img.shields.io/badge/Made%20with-Sphinx-1f425f.svg
:target: http://sphinx-doc.org/
.. |Maintained? Yes!| image:: https://img.shields.io/badge/Maintained%3F-yes-green.svg
:target: https://bitbucket.org/lbesson/web-sphinx/commits/
.. |Ask Me Anything!| image:: https://img.shields.io/badge/Ask%20me-anything-1abc9c.svg
:target: https://bitbucket.org/lbesson/ama
.. |Website perso.crans.org| image:: https://img.shields.io/website-up-down-green-red/http/perso.crans.org.svg
:target: https://perso.crans.org/
.. |Screenshot demo of my web pages in English (1/2)| image:: demo_en.png
.. |Screenshot demo of my web pages in French (2/2)| image:: demo_fr.png
.. |PyPI pyversions| image:: https://img.shields.io/pypi/pyversions/ansicolortags.svg
:target: https://pypi.python.org/pypi/ansicolortags/
.. |GPLv3 license| image:: https://img.shields.io/badge/License-GPLv3-blue.svg
:target: https://perso.crans.org/besson/LICENSE.html
.. |ForTheBadge built-with-love| image:: http://ForTheBadge.com/images/badges/built-with-love.svg
:target: https://bitbucket.org/lbesson/web-sphinx/commits/
.. |Analytics| image:: https://ga-beacon.appspot.com/UA-38514290-17/bitbucket.org/lbesson/web-sphinx/README.md?pixel
:target: https://bitbucket.org/lbesson/web-sphinx
.. |ForTheBadge uses-badges| image:: http://ForTheBadge.com/images/badges/uses-badges.svg
:target: http://ForTheBadge.com
.. |ForTheBadge uses-git| image:: http://ForTheBadge.com/images/badges/uses-git.svg
:target: https://bitbucket.org/lbesson
.. |ForTheBadge uses-html| image:: http://ForTheBadge.com/images/badges/uses-html.svg
:target: http://ForTheBadge.com
.. |ForTheBadge uses-css| image:: http://ForTheBadge.com/images/badges/uses-css.svg
:target: http://ForTheBadge.com
.. |ForTheBadge uses-js| image:: http://ForTheBadge.com/images/badges/uses-js.svg
:target: http://ForTheBadge.com