Browse Source

docs: fix the highlighting

default is "python", that's why some help fragments and bash scripts looked strange.
Thomas Waldmann 9 years ago
parent
commit
cf4d761042
9 changed files with 15 additions and 2 deletions
  1. 6 1
      README.rst
  2. 1 0
      docs/api.rst
  3. 1 0
      docs/deployment.rst
  4. 1 0
      docs/development.rst
  5. 2 1
      docs/faq.rst
  6. 1 0
      docs/installation.rst
  7. 1 0
      docs/internals.rst
  8. 1 0
      docs/quickstart.rst
  9. 1 0
      docs/usage.rst

+ 6 - 1
README.rst

@@ -1,5 +1,7 @@
 |screencast|
 
+.. highlight:: bash
+
 What is BorgBackup?
 ===================
 
@@ -87,7 +89,10 @@ Initialize a new backup repository and create a backup archive::
     $ borg init /path/to/repo
     $ borg create /path/to/repo::Saturday1 ~/Documents
 
-Now doing another backup, just to show off the great deduplication::
+Now doing another backup, just to show off the great deduplication:
+
+.. code-block:: none
+   :emphasize-lines: 11
 
     $ borg create -v --stats /path/to/repo::Saturday2 ~/Documents
     -----------------------------------------------------------------------------

+ 1 - 0
docs/api.rst

@@ -1,3 +1,4 @@
+.. highlight:: python
 
 API Documentation
 =================

+ 1 - 0
docs/deployment.rst

@@ -1,4 +1,5 @@
 .. include:: global.rst.inc
+.. highlight:: none
 .. _deployment:
 
 Deployment

+ 1 - 0
docs/development.rst

@@ -1,4 +1,5 @@
 .. include:: global.rst.inc
+.. highlight:: bash
 .. _development:
 
 Development

+ 2 - 1
docs/faq.rst

@@ -1,5 +1,6 @@
-.. _faq:
 .. include:: global.rst.inc
+.. highlight:: none
+.. _faq:
 
 Frequently asked questions
 ==========================

+ 1 - 0
docs/installation.rst

@@ -1,4 +1,5 @@
 .. include:: global.rst.inc
+.. highlight:: bash
 .. _installation:
 
 Installation

+ 1 - 0
docs/internals.rst

@@ -1,4 +1,5 @@
 .. include:: global.rst.inc
+.. highlight:: none
 .. _internals:
 
 Internals

+ 1 - 0
docs/quickstart.rst

@@ -1,4 +1,5 @@
 .. include:: global.rst.inc
+.. highlight:: bash
 .. _quickstart:
 
 Quick Start

+ 1 - 0
docs/usage.rst

@@ -1,4 +1,5 @@
 .. include:: global.rst.inc
+.. highlight:: none
 .. _detailed_usage:
 
 Usage