-
Notifications
You must be signed in to change notification settings - Fork 419
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
Docs: new light theme and various other updates #209
Conversation
Not sure why I thought they aren't.
For some reason I grabbed a totally broken inventory file at first. This one is less broken but the names get inspected weird so it needs to be fixed up after.
Somehow it doesn't generated when it's there. Or something.
The resulting CSS is generated by the build.sh script and added to .gitignore -- changes should be made to theme.css / pygments-pastie.css instead.
Similarly to how API does that.
The URL scheme got stabilized there, so all links are different now.
Request to change |
Done in 810e303, thanks. Also did a minor change on the API side (facebookresearch/habitat-lab@e66bfa8), felt more consistent that way. |
So it's "relocatable", i.e. when running the whole site on localhost, the navbar links goes to the main site instead of out into the wild.
A counterpart to facebookresearch/habitat-sim#209. What this does: * Rewrites everything that was in Markdown before to a reStructuredText (four tutorial files) * Rewrites docstrings to use the m.css Sphinx-like syntax * I took the externally-referenced images and put them directly in the repo because I think it's easier to ensure it stays in sync that way (and those aren't too big). If that's a problem, I can revert that change. * Otherwise, everything kinda the same as on the Sim side. Most importantly, this references a lot of files from the habitat-sim repository and also puts the output there. This is done mainly in order to keep the style and symbol crosslinking in sync and also so you have C++ Sim, Python Sim and API docs next to each other, with them being easily switchable from the top navbar.
|
||
- `New Actions <std:doc:new-actions>` | ||
- `Notebooks <std:doc:notebooks>` | ||
- `Creating a stereo agent <std:doc:stereo-agent>` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be links yet?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you mean the TODO, no, that still holds ... i had to prioritize to not spend next 16 years on the generator :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, no problem, just wanted to make sure there wasn't something I was missing :)
Lists are also objects and [[]] * 5 just creates a list of 5 pointers to the same thing.
* docs: dang, I forgot to clean this up. * docs: relative paths actually *do* work. Not sure why I thought they aren't. * Cross-link to the quaternion package as well. For some reason I grabbed a totally broken inventory file at first. This one is less broken but the names get inspected weird so it needs to be fixed up after. * Move the build_docs.sh helper into the docs directory. * Updated m.css submodule. * docs: capitalize project name. * docs: move the generated tagfile outside of the doxygen output dir. Somehow it doesn't generated when it's there. Or something. * docs: make it possible to supply external m.css. * docs: switch to a custom light theme. The resulting CSS is generated by the build.sh script and added to .gitignore -- changes should be made to theme.css / pygments-pastie.css instead. * docs: link to tutorials from the main page. Similarly to how API does that. * docs: update magnum bindings doc inventory. The URL scheme got stabilized there, so all links are different now. * docs: less confusing names in the navbar. * docs: make main project URL just a /. So it's "relocatable", i.e. when running the whole site on localhost, the navbar links goes to the main site instead of out into the wild.
Motivation and Context
What's done:
quaternion
types as well (originally it was using some broken*.inv
file and nothing worked)*.inv
file got updated to fix that.build_docs.sh
helper got moved intodocs/
and it now also does CSS compilation and has a possibility to use an external m.css project instead of the submodule (I'm using that a lot for iterations)How Has This Been Tested
git submodule update --init cd docs ./build.sh open ../build/docs/habitat-sim/index