LibreTexts / ngshare

nbgrader sharing service
https://ngshare.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
17 stars 17 forks source link

Polish the documentation #98

Closed Lawrence37 closed 4 years ago

Lawrence37 commented 4 years ago

While reviewing the documentation, I made some changes which you will see in a pull request. There are some additional things that we may want to address.

rkevin-arch commented 4 years ago

We resolved this via Zoom but still putting it here for documentation purposes: rendering the tikz image needs some dependencies. On Arch Linux, this can be installed using pacman -S texlive-core texlive-latexextra texlive-pictures. Other distros may have slightly different package names. TODO: add documentation on how to build docs

lxylxy123456 commented 4 years ago

@rkevin-arch You can put this in the documentation. I guess Fedora is basically the same.

lxylxy123456 commented 4 years ago

No, they are not the same. You can just put the note you wrote ("other distros may ...") on docs

lxylxy123456 commented 4 years ago

@rkevin-arch You can add a link to: https://github.com/sphinx-contrib/tikz#prerequisites-and-configuration

lxylxy123456 commented 4 years ago

Or this: https://sphinxcontrib-tikz.readthedocs.io/en/latest/#prerequisites-and-configuration

rkevin-arch commented 4 years ago

Closing since we're mostly finished with documentation updates