Welcome to Git Workshop Part 3 on Documentation! ================================================ Here are the basic git concepts that we covered in the first workshop, that will be needed in today's workshop. Feel free to take a look, in case you forgot something. Git Basics ++++++++++ .. toctree:: :maxdepth: 2 git-basics/new_repo git-basics/git_workflow Documentation Basics ++++++++++++++++++++ Today we will learn how to write documentation and publish it on the web. At first we will start with the basics of documentation. .. toctree:: :maxdepth: 2 docu-content/docu_101 docu-content/reStructuredText Deploy Documentation ++++++++++++++++++++ The second session will be about publishing your documentation on the web. .. toctree:: :maxdepth: 2 docu-content/sphinx docu-content/continuous-deployment docu-content/read_the_docs_instructions Docstring +++++++++ And the third session will be about documenting more detailed code interfaces. .. toctree:: :maxdepth: 2 docu-content/doc-strings Exercises +++++++++ Here you can find some tasks to practise the ideas introduced above. .. toctree:: :maxdepth: 2 tasks/task_0 tasks/task_1 tasks/task_2 tasks/task_3 tasks/task_4 Indices and tables ================== * :ref:`genindex` * :ref:`search`