Tech Talks | Tech Documentation (Readthedocs & Sphinx)

This is presentation for tech talk about tech documentation using readthedocs and sphinx.

Transcript

1. Technical Documentation TOOLS
2. INTRODUCTION What the documentation is important ? YES What tools can we use ? Etc.
3. Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license. Sphinx uses reStructuredText (.rst) as its markup language, and many of its strengths come from the power and straight forwardness of reStructuredText and its parsing and translating suite, the Docutils. Who is that ?
4. reStructuredText is an easy-to-read, what-you-see- is-what-you-get plaintext markup syntax and parser system. reStructuredText is a revision and reinterpretation of the StructuredText and Setext lightweight markup systems Who is that ?
5. Who is that ? Read the Docs is simplifies software for hosting documentation sphinx provide automating building, versioning, and hosting of your docs for you.
7. Advantage use this tools ? FREE (85,603 open source projects share their docs) MULTIPLE FILE FORMAT (PDF, Epub, Html) WEBHOOK (Github, Gitlab, Mercurial, Bazaar and Subversion) MULTIPLE FILE VERSION
8. Manual Import Repository Integration
9. Automatic Import Repository
10. Setup Webhook for Repository
11. Setup Webhook Readthedocs in Github
12. Installation The first way : 1. Create Folder with name “docs”. 2. Create a file .rst and type your content. Second way : 1. Open your terminal and type this command : $ pip install sphinx sphinx-autobuild $ cd /path/to/project $ mkdir docs $ cd docs $ sphinx-quickstart $ make html or sphinx-build –b html sourcedir builddir
13. CHEAT SHEET
15. Source : http://docutils.sourceforge.net/docs/user/rst/cheatsheet.txt http://rst.ninjs.org/ https://livesphinx.herokuapp.com
16. THANK YOU @Risyandi https://speakerdeck.com/risyandi