search

robotology / funny-things

A collection of "funny" yet useful behaviors for the iCub
https://robotology.github.io/funny-things
GNU General Public License v2.0
6 stars 12 forks source link

Fix the documentation #10

Closed pattacini closed 7 years ago

pattacini commented 7 years ago

Hi @alecive

Could you please give a glance at the documentation? It seems it doesn't show up correctly in some of the pages.

Thanks!

cc @vtikha

alecive commented 7 years ago

Ok so to put things clear:

Do you confirm? I would like to not have mismatch with your experience.

Also, if this is the case, we should decide what to do with the whole github page thing. Specifically: are we going to keep it? Is it any useful in the current state? Are the pages that right now give a 404 worth having?

pattacini commented 7 years ago

For the first question: it's all ok.

For the second question, what do you mean? We definitely stick to GH pages, though the effort to spread this way of producing documentation is still to be planned.

I'd suggest to keep those pages giving 404 error.

alecive commented 7 years ago

Ok, I'll work on it. It is probably due to some changes on jekyll (it was upgraded some months ago).

alecive commented 7 years ago

Ok the issues should be fixed. They were due to some major jekyll changes that were breaking the API here and there.

I also improved the website in multiple ways, but nothing that should affect the functionality.

Most of these things are difficult to test locally, though. I took a look at the website, and everything seems fine to me, but please report if you experience any other problem. Closing for now.

pattacini commented 7 years ago

Working nicely, thanks a lot!

pattacini commented 7 years ago

Hey @alecive always remember to squash commits of gh-pages branches in order to be in the condition described here: https://github.com/robotology/how-to-document-modules#updating-the-documentation.

I've already done the squashes 😄 ➡️ git pull --rebase your local branches!

alecive commented 7 years ago

eheh forgot about that :smile: On the same topic, is the doxy in need of an update?

pattacini commented 7 years ago

Don't think so...