Skip to content
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

Move documentation to Sphinx / Read the Docs #239

Open
scotws opened this issue Jun 9, 2019 · 1 comment
Open

Move documentation to Sphinx / Read the Docs #239

scotws opened this issue Jun 9, 2019 · 1 comment
Assignees
Labels
docs Stuff that needs to be fixed/change in the documentation leave for now Remember this for the far, far, future

Comments

@scotws
Copy link
Owner

scotws commented Jun 9, 2019

The custom setup for documentation was fun, but Sphinx (developed for Python documentation) solves these problems in a simply, standardized way and can be combined with Read the Docs.

For an introduction, see http://www.ericholscher.com/blog/2016/jul/1/sphinx-and-rtd-for-writers/

@scotws scotws added the docs Stuff that needs to be fixed/change in the documentation label Jun 9, 2019
@scotws scotws self-assigned this Jun 9, 2019
@scotws
Copy link
Owner Author

scotws commented Jun 15, 2019

So I've done some experimenting with Read the Docs, and this is how it works as a simple example: https://github.com/scotws/ubuntu-nas is the source and https://ubuntu-nas.readthedocs.io/en/latest/index.html the result on Read the Docs (with a very, very simple theme). ReStructured Text is not half as powerful as AsciiDoc, but the integration is far better, and we can get rid of all kinds of silly shell scripts.

@scotws scotws added the leave for now Remember this for the far, far, future label Apr 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Stuff that needs to be fixed/change in the documentation leave for now Remember this for the far, far, future
Projects
None yet
Development

No branches or pull requests

1 participant