Contents
Packages
Source file formats
Sphinx themes
Git and Github Resources
For user documentation, contributor guides, and communications content, we use:
Sphinx
For developer API documentation (especially for JupyterLab js repos), we use:
swagger
We use the following input source file formats when developing Sphinx documentation:
reStructuredText (.rst)
.rst
Markdown (.md)
.md
Notebook (.ipynb)
.ipynb
A modern code editor should be used. Many are available including Atom, SublimeText, gedit, vim, emacs. Atom is a good choice for new contributors.
Our projects use the following themes:
sphinx_rtd_theme (currently used by Jupyter projects)
jupyter_sphinx_theme (used by ipywidgets)
If this is your first time working with Github or git, you can leverage the following resources to learn about the tools.
Try Git
Github Guides
Git Real
Git Documentation
Git Rebase