Documentation [WIP]

[1094]

Sphinx project documentation.

[1094]

The pages with the most content are the index, features, install, and tips.

[samuelallan72]

To answer your original question, yes you're definitely on track, and this looks great! Please note that I'm more than happy to help implement any of the changes I suggested if you like. Just let me know what your plans are. :)

[samuelallan72]

One final point - can we use a built-in sphinx theme? I know this theme is nice, but then we need to maintain it and there are a lot of extra files in the repo now... :/

[1094]

• no duplicating screenshot image files. perhaps move the screenshots directory into the docs dir.

Yes. I can move the whole directory.

[1094]

I'm not sure what I did wrong the first time, but now there seems to be applied CSS without the extra theme files, so source/_static should be empty. That last push should have taken care of everything but the Sphinx generated HTML folder. I'll remove it from future commits (unless you want some theme changes).

I will work on adding the content to the rest of the pages this week. I'll do try to do a commit after each page so you can check out the actual content.

[samuelallan72]

I just removed that generated-html directory for you. By default the output goes to build/html (when running make html), which is what we want, so this extra directory of files isn't required.

[1094]

So, I have a question about a keyboard shortcut/setting I haven't used before. I'm sure how to write up what they do.

First is kb_tabstop4, kb_tabstop4, kb_tabstop8. I'm guessing they set the tab stop? But in what way?

• kb_view_note_ext
• kb_search_prev_gstyle
• kb_search_prev_regex
• kb_copy_note_text

For the last one, I can't figure out where it's copying the text to.

Thanks.

[samuelallan72]

• kb_view_note_ext: view note in external pager (controlled by cfg_pager or $PAGER in env)
• kb_search_prev_gstyle: same as kb_search_gstyle but search direction reverse. (gstyle search is basically a keyword search with smarts) I'm not sure exactly what the reverse search direction actually does though.
• kb_search_prev_regex: same as kb_search_regex but search direction in reverse.
• kb_copy_note_text: copies the focused line of text to the system clipboard if available (checks for xsel and pbcopy commands). It should be noted that this will only work if running in an environment where the x11 or macos clipboard is accessible.

[1094]

I believe the draft is complete.

[samuelallan72]

Looks awesome! Thanks for your work. :grinning:

[samuelallan72]

Note: I squash merged so that the large files that were committed and since removed don't end up in the git history.

[1094]

Thanks for letting me help out. This was an awesome learning experience!

[samuelallan72]

@1094 docs are live! https://sncli.readthedocs.io/en/latest/

[1094]

@swalladge Nice! Although, (and I don't know if this is important for you) something changed with the theme when posting it, it no longer adjusts to window size. Also, I missed a few typos. (Should I do another pull request to correct them or do you wanna grab them?)

[samuelallan72]

@1094 sure if there's anything you'd like to work on, feel free to open a pr. I'll probably have another look over it sometime as well, but don't let that stop you.