R2Northstar
Rst help cheatsheet
I was starting to forget rst syntax and tricks so I made this, figured if i'm going to make this. Might as well make it public.
This is great, but i would maybe prefer it in a seperate document. if you could move that over, i'll merge.
Alright, will do.
My TODO (because i forgor too much):
- Clean up the RST TESTING DANGER
- Move to separate page
- Fix Header 1 appearing on ToC
- Add Links, Hyperlinks, Relative Links
- Add References (the thing that makes making tables much better)
Because I'm procrastinating from doing my C++ classwork. I did a commit today smh. Anyways,
- Cleaned up Danger Zone.
- Moved to separate page
- Fixed header problem
TODO
- Links
- References
- Tables
- maybe Directives (just to make reading other docs easier)
Having done a proper read through this, i really like how many things are in here. theres 2 concerns i have:
- a lot of the more complex features don't have a codeblock showing their usage, it would be neat to have code blocks for the full usage of some more elements.
- i don't thing the conversational style fits with most of the docs - i would much prefer a more direct style. "I prefer" etc can be replaced with "a recommended style" or similar.
i would prefer to get this merged soon, since I want to start work on #100 which will move around almost all files
- Which features don't have code blocks? Only feature missing a code block (or plain text) are the tables. Which are unfinished/not done.
- Hmm. I always thought "I prefer" was weak and says without confidence, if you prefer it though. Sure, I'll make those changes. Okay. I'll try getting this to a mergeable state.
Found these useful, saving them here. toctree little hints
- https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html#include-other-rst-files-with-the-toctree-directive
- https://devguide.python.org/documentation/markup/
for tables? and generally new and cool
- https://sublime-and-sphinx-guide.readthedocs.io/en/latest/tables.html
another new demo doc
- https://sphinx-rtd-theme.readthedocs.io/en/stable/demo/demo.html
Might not work with our theme. So ask Gecko or Laundro for our theme name. but, still very cool stuff
- https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html
okay this one is actually really cool towards the end
- https://docs.anaconda.com/restructuredtext/detailed/
i'm mostly fine with merging this soon, but who owns the copyright to the cat picture?
Not sure. I just googled and found it. I could replace it with a paint.exe drawing, unless you have a better recommendation.
