-
Notifications
You must be signed in to change notification settings - Fork 26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Website scaffold #195
Website scaffold #195
Conversation
2bcc33b
to
65e37eb
Compare
I am not fully convinced by the |
It is the name we used in our publication. Though, for the website we can change it and make it nicer. The two options are:
|
I personally like |
And probably that would also work better for the indexing of search engines. Agreed. |
821f6df
to
0c042b1
Compare
Generated with: sphinx-quickstart -p "Gym-Ignition" -a "Istituto Italiano di Tecnologia" -r 1.0 -l en --ext-autodoc --ext-todo --ext-mathjax --ext-githubpages With no separation of source and build folders.
0c042b1
to
4435a10
Compare
This PR initializes the empty website https://robotology.github.io/gym-ignition. It uses:
master
,devel
, andv*
tags are matched.There are two new targets:
doxygen
build the Doxygen documentationsphinx
builds the website and generates the folder<build>/html
that can be deployedThe integration between sphinx and doxygen is not yet there and it will be done in another PR. I managed to make Sphinx display also the C++ documentation using breathe, inspired by this amazing tutorial, but I will populate APIs content in another PR.
At the moment I pushed the content manually. Sooner or later I will implement a new Workflow to automatize the process.
Note: there is a similar contrib extension to build a multi-version website, but it's currently bugged (sphinx-contrib/sphinxcontrib-versioning#78). Though, the SMV extension works quite well.