Auton Lab Intranet major update
Predrag Punosevac
predragp at andrew.cmu.edu
Sun Apr 26 15:23:24 EDT 2020
Dear Autonians,
As the remote work is becoming the new norm during the pandemic, I
decided to do the major update of our Intranet pages. We are
increasingly relay on documentation to preform our daily assignments so
could no longer procrastinate
Please use the link below
https://www.autonlab.org/intranet
username: auton
password: Dr.Who
to log and see the result. As you might imagine editing html files by
hand didn't scale-up too well so I decided to deploy Sphinx Python
Documentation Generator
https://www.sphinx-doc.org/en/master/
That could be useful for documenting other lab projects and code. Sphinx
uses reStructuredText markdown as its markup language. Both the language
and the documentation preparation software are super easy to learn.
Cheat sheets for both Sphinx and reStructuredText are numerous and easy
to follow. For example
https://matplotlib.org/sampledoc/cheatsheet.html
Notice the show source tab which we also have on our website.
If you would like to contribute to the Auton Lab Intranet/wiki pages
please create the document using .rst format and I would be happy to
put it onto the server.
At this point I really need to make a public apiology to Sarveshwaran
Jayaraman and Andrew Williams. Those two have tried on numerous
occasions over the past two months to make contributions both to our
Intranet and to our main website. Unfortunately for most part I was busy
with other things and ignored the stuff they were sending to me. I
promised that as soon as I get some sleep I would download
Sarveshwaran's documents from the CMU Box as well as apply Andrew's
patches/updates to the main web site.
Cheers,
Predrag
More information about the Autonlab-users
mailing list