restic/doc/100_references.rst

..
  Normally, there are no heading levels assigned to certain characters as the structure is
  determined from the succession of headings. However, this convention is used in Python’s
  Style Guide for documenting which you may follow:

  # with overline, for parts
  * for chapters
  = for sections
  - for subsections
  ^ for subsubsections
  " for paragraphs

##########
References
##########

******
Design
******

.. include:: design.rst
.. include:: cache.rst
.. include:: REST_backend.rst
-												doc: Refactors the documentation

This commit refactors the documentation according to my proposal in #1273
and the discussion I had with fd0 on IRC.

The bits from the manual that I could not immediately put into the new
structure are contained in manual_rest.rst Anything else is still there,
nothing has been deleted.

I changed the heading markup to follow the convention used in Python’s
Style Guide for documentation, this convention is explained in a comment
at the top of every file.

I also added a paragraph on installing restic on Debian.

											
										
										
											2017-09-30 16:01:19 -04:00
+								..
 								  Normally, there are no heading levels assigned to certain characters as the structure is
 								  determined from the succession of headings. However, this convention is used in Python’s
 								  Style Guide for documenting which you may follow:
 								  # with overline, for parts
 								  * for chapters
 								  = for sections
 								  - for subsections
 								  ^ for subsubsections
 								  " for paragraphs
 								##########
 								References
 								##########
 								******
-												Documentation: Refactor and switch to Sphinx

* convert documentation to reStructuredText
* switch from mkdocs to sphinx
* rewrite README.md (now .rst) to include less information and be more
attractive

											
										
										
											2017-04-17 14:53:38 -04:00
+								Design
-												doc: Refactors the documentation

This commit refactors the documentation according to my proposal in #1273
and the discussion I had with fd0 on IRC.

The bits from the manual that I could not immediately put into the new
structure are contained in manual_rest.rst Anything else is still there,
nothing has been deleted.

I changed the heading markup to follow the convention used in Python’s
Style Guide for documentation, this convention is explained in a comment
at the top of every file.

I also added a paragraph on installing restic on Debian.

											
										
										
											2017-09-30 16:01:19 -04:00
+								******
-												Documentation: Refactor and switch to Sphinx

* convert documentation to reStructuredText
* switch from mkdocs to sphinx
* rewrite README.md (now .rst) to include less information and be more
attractive

											
										
										
											2017-04-17 14:53:38 -04:00
-												doc: Split references out into smaller files

Closes #1852

											
										
										
											2018-06-18 16:17:30 -04:00
+								.. include:: design.rst
 								.. include:: cache.rst
 								.. include:: REST_backend.rst