Docs: new light theme and various other updates #209
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
facebook-github-bot
added
the
CLA Signed
|
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.
mathfac
pushed a commit
to facebookresearch/habitat-lab
that referenced
this pull request
Sep 16, 2019
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.
erikwijmans
approved these changes
Sep 17, 2019
erikwijmans
reviewed
Sep 17, 2019
|
|
||
| - `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.
Should this be links yet?
There was a problem hiding this comment.
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.
Yep, no problem, just wanted to make sure there wasn't something I was missing :)
eundersander
pushed a commit
to eundersander/habitat-sim
that referenced
this pull request
Aug 6, 2020
Lists are also objects and [[]] * 5 just creates a list of 5 pointers to the same thing.
Ram81
pushed a commit
to Ram81/habitat-web-sim
that referenced
this pull request
Dec 10, 2020
* 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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
What's done:
quaterniontypes as well (originally it was using some broken*.invfile and nothing worked)*.invfile got updated to fix that.build_docs.shhelper 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