Skip to content
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

Merged
merged 10 commits into from
May 3, 2020
Merged

Conversation

diegoferigo
Copy link
Collaborator

@diegoferigo diegoferigo commented May 3, 2020

This PR initializes the empty website https://robotology.github.io/gym-ignition. It uses:

There are two new targets:

  • doxygen build the Doxygen documentation
  • sphinx builds the website and generates the folder <build>/html that can be deployed

The 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.

@traversaro
Copy link
Contributor

I am not fully convinced by the Gym-Ignition name with both capital letters and dash -, but that is just personal taste.

@diegoferigo
Copy link
Collaborator Author

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:

  • Gym Ignition
  • gym-ignition

@traversaro
Copy link
Contributor

I personally like gym-ignition because it is consistent with GitHub repo, pip package, package in any possible package manager in the world, but that is personal taste.

@diegoferigo
Copy link
Collaborator Author

And probably that would also work better for the indexing of search engines. Agreed.

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants