summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2016-04-16 16:21:22 -0700
committerSteve Piercy <web@stevepiercy.com>2016-04-16 16:21:22 -0700
commit9b0ac053084b0811111fdc33b969598e1b78f2e6 (patch)
tree9c047b0a07c8a647d1c0246598685b645676b412 /docs
parentd19e9902ede0b1cc40991b423c12e8a95d430e0e (diff)
parent86e79cf1db4c789d4fcb1cf75a42189ef3fd21ec (diff)
downloadpyramid-9b0ac053084b0811111fdc33b969598e1b78f2e6.tar.gz
pyramid-9b0ac053084b0811111fdc33b969598e1b78f2e6.tar.bz2
pyramid-9b0ac053084b0811111fdc33b969598e1b78f2e6.zip
Merge pull request #2509 from stevepiercy/1.7-branch
replace ps1con with doscon for lexer and syntax highlighting
Diffstat (limited to 'docs')
-rw-r--r--docs/conventions.rst36
-rw-r--r--docs/narr/i18n.rst2
-rw-r--r--docs/narr/install.rst2
-rw-r--r--docs/narr/project.rst6
-rw-r--r--docs/tutorials/wiki/definingviews.rst2
-rw-r--r--docs/tutorials/wiki/distributing.rst2
-rw-r--r--docs/tutorials/wiki/installation.rst26
-rw-r--r--docs/tutorials/wiki2/definingmodels.rst2
-rw-r--r--docs/tutorials/wiki2/distributing.rst2
-rw-r--r--docs/tutorials/wiki2/installation.rst28
-rw-r--r--docs/tutorials/wiki2/tests.rst2
11 files changed, 55 insertions, 55 deletions
diff --git a/docs/conventions.rst b/docs/conventions.rst
index 0346f1107..4469d0c73 100644
--- a/docs/conventions.rst
+++ b/docs/conventions.rst
@@ -53,46 +53,46 @@ Code and configuration file blocks are presented in the following style:
Example blocks representing UNIX shell commands are prefixed with a ``$``
character, e.g.:
- .. code-block:: text
+ .. code-block:: bash
- $ $VENV/bin/nosetests
+ $ $VENV/bin/py.test tutorial/tests.py -q
(See :term:`venv` for the meaning of ``$VENV``)
Example blocks representing Windows ``cmd.exe`` commands are prefixed with a
drive letter and/or a directory name, e.g.:
- .. code-block:: text
+ .. code-block:: doscon
- c:\examples> %VENV%\Scripts\nosetests
+ c:\examples> %VENV%\Scripts\py.test tutorial\tests.py -q
(See :term:`venv` for the meaning of ``%VENV%``)
Sometimes, when it's unknown which directory is current, Windows ``cmd.exe``
example block commands are prefixed only with a ``>`` character, e.g.:
- .. code-block:: text
+ .. code-block:: doscon
- > %VENV%\Scripts\nosetests
+ > %VENV%\Scripts\py.test tutorial\tests.py -q
When a command that should be typed on one line is too long to fit on a page,
-the backslash ``\`` is used to indicate that the following printed line
-should actually be part of the command:
+the backslash ``\`` is used to indicate that the following printed line should
+be part of the command:
- .. code-block:: text
+ .. code-block:: bash
- c:\bigfntut\tutorial> %VENV%\Scripts\nosetests --cover-package=tutorial \
- --cover-erase --with-coverage
+ $VENV/bin/py.test tutorial/tests.py --cov-report term-missing \
+ --cov=tutorial -q
-A sidebar, which presents a concept tangentially related to content
-discussed on a page, is rendered like so:
+A sidebar, which presents a concept tangentially related to content discussed
+on a page, is rendered like so:
.. sidebar:: This is a sidebar
Sidebar information.
-When multiple objects are imported from the same package,
-the following convention is used:
+When multiple objects are imported from the same package, the following
+convention is used:
.. code-block:: python
@@ -103,9 +103,9 @@ the following convention is used:
It may look unusual, but it has advantages:
-* It allows one to swap out the higher-level package ``foo`` for something
- else that provides the similar API. An example would be swapping out
- one database for another (e.g., graduating from SQLite to PostgreSQL).
+* It allows one to swap out the higher-level package ``foo`` for something else
+ that provides the similar API. An example would be swapping out one database
+ for another (e.g., graduating from SQLite to PostgreSQL).
* Looks more neat in cases where a large number of objects get imported from
that package.
diff --git a/docs/narr/i18n.rst b/docs/narr/i18n.rst
index a3f730f0c..014f314ad 100644
--- a/docs/narr/i18n.rst
+++ b/docs/narr/i18n.rst
@@ -292,7 +292,7 @@ Installing Lingua is done with the Python packaging tools. If the
application lives at the environment variable ``%VENV%``, you can install
Lingua like so:
-.. code-block:: ps1con
+.. code-block:: doscon
C> %VENV%\Scripts\pip install lingua
diff --git a/docs/narr/install.rst b/docs/narr/install.rst
index c767ed95a..3e5523262 100644
--- a/docs/narr/install.rst
+++ b/docs/narr/install.rst
@@ -186,7 +186,7 @@ After installing Python as described previously in
#. Make a :term:`virtual environment` workspace:
- .. code-block:: ps1con
+ .. code-block:: doscon
c:\> set VENV=c:\env
# replace "x" with your minor version of Python 3
diff --git a/docs/narr/project.rst b/docs/narr/project.rst
index 24e484c11..81fc9acf4 100644
--- a/docs/narr/project.rst
+++ b/docs/narr/project.rst
@@ -159,7 +159,7 @@ On UNIX:
Or on Windows:
-.. code-block:: ps1con
+.. code-block:: doscon
> cd MyProject
> %VENV%\Scripts\pip install -e .
@@ -197,7 +197,7 @@ On UNIX:
On Windows:
-.. code-block:: ps1con
+.. code-block:: doscon
> %VENV%\Scripts\pip install -e ".[testing]"
@@ -213,7 +213,7 @@ On UNIX:
On Windows:
-.. code-block:: ps1con
+.. code-block:: doscon
> %VENV%\Scripts\py.test myproject\tests.py -q
diff --git a/docs/tutorials/wiki/definingviews.rst b/docs/tutorials/wiki/definingviews.rst
index 94871d4ab..ac94d8059 100644
--- a/docs/tutorials/wiki/definingviews.rst
+++ b/docs/tutorials/wiki/definingviews.rst
@@ -72,7 +72,7 @@ On UNIX:
On Windows:
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut> cd tutorial
c:\pyramidtut\tutorial> %VENV%\Scripts\pip install -e .
diff --git a/docs/tutorials/wiki/distributing.rst b/docs/tutorials/wiki/distributing.rst
index 8bdf51021..c3037f396 100644
--- a/docs/tutorials/wiki/distributing.rst
+++ b/docs/tutorials/wiki/distributing.rst
@@ -18,7 +18,7 @@ On UNIX:
On Windows:
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut> %VENV%\Scripts\python setup.py sdist
diff --git a/docs/tutorials/wiki/installation.rst b/docs/tutorials/wiki/installation.rst
index b1b89d117..dbf995595 100644
--- a/docs/tutorials/wiki/installation.rst
+++ b/docs/tutorials/wiki/installation.rst
@@ -30,7 +30,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\> mkdir pyramidtut
@@ -53,7 +53,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\> set VENV=c:\pyramidtut
@@ -62,13 +62,13 @@ path to the command for your Python version.
Python 2.7:
-.. code-block:: ps1con
+.. code-block:: doscon
c:\> c:\Python27\Scripts\virtualenv %VENV%
Python 3.5:
-.. code-block:: ps1con
+.. code-block:: doscon
c:\> c:\Python35\Scripts\python -m venv %VENV%
@@ -86,7 +86,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\> %VENV%\Scripts\pip install --upgrade pip setuptools
@@ -104,7 +104,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\> %VENV%\Scripts\pip install pyramid
@@ -124,7 +124,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\> cd pyramidtut
@@ -157,7 +157,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut> %VENV%\Scripts\pcreate -s zodb tutorial
@@ -190,7 +190,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut> cd tutorial
c:\pyramidtut\tutorial> %VENV%\Scripts\pip install -e .
@@ -240,7 +240,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut\tutorial> %VENV%\Scripts\pip install -e ".[testing]"
@@ -263,7 +263,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut\tutorial> %VENV%\Scripts\py.test tutorial\tests.py -q
@@ -296,7 +296,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut\tutorial> %VENV%\Scripts\py.test --cov=tutorial \
--cov-report=term-missing tutorial\tests.py
@@ -344,7 +344,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut\tutorial> %VENV%\Scripts\pserve development.ini --reload
diff --git a/docs/tutorials/wiki2/definingmodels.rst b/docs/tutorials/wiki2/definingmodels.rst
index 714ab7c21..6520613ea 100644
--- a/docs/tutorials/wiki2/definingmodels.rst
+++ b/docs/tutorials/wiki2/definingmodels.rst
@@ -58,7 +58,7 @@ On UNIX:
On Windows:
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut> cd tutorial
c:\pyramidtut\tutorial> %VENV%\Scripts\pip install -e .
diff --git a/docs/tutorials/wiki2/distributing.rst b/docs/tutorials/wiki2/distributing.rst
index 7bc9ec044..f264448b0 100644
--- a/docs/tutorials/wiki2/distributing.rst
+++ b/docs/tutorials/wiki2/distributing.rst
@@ -17,7 +17,7 @@ On UNIX:
On Windows:
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut> %VENV%\Scripts\python setup.py sdist
diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst
index c3350c792..f4676345e 100644
--- a/docs/tutorials/wiki2/installation.rst
+++ b/docs/tutorials/wiki2/installation.rst
@@ -30,7 +30,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\> mkdir pyramidtut
@@ -53,7 +53,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\> set VENV=c:\pyramidtut
@@ -62,13 +62,13 @@ path to the command for your Python version.
Python 2.7:
-.. code-block:: ps1con
+.. code-block:: doscon
c:\> c:\Python27\Scripts\virtualenv %VENV%
Python 3.5:
-.. code-block:: ps1con
+.. code-block:: doscon
c:\> c:\Python35\Scripts\python -m venv %VENV%
@@ -86,7 +86,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\> %VENV%\Scripts\pip install --upgrade pip setuptools
@@ -104,7 +104,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\> %VENV%\Scripts\pip install pyramid
@@ -142,7 +142,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\> cd pyramidtut
@@ -178,7 +178,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut> %VENV%\Scripts\pcreate -s alchemy tutorial
@@ -211,7 +211,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut> cd tutorial
c:\pyramidtut\tutorial> %VENV%\Scripts\pip install -e .
@@ -259,7 +259,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut\tutorial> %VENV%\Scripts\pip install -e ".[testing]"
@@ -282,7 +282,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut\tutorial> %VENV%\Scripts\py.test tutorial\tests.py -q
@@ -315,7 +315,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut\tutorial> %VENV%\Scripts\py.test --cov=tutorial \
--cov-report=term-missing tutorial\tests.py
@@ -388,7 +388,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut\tutorial> %VENV%\Scripts\initialize_tutorial_db development.ini
@@ -442,7 +442,7 @@ On UNIX
On Windows
^^^^^^^^^^
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut\tutorial> %VENV%\Scripts\pserve development.ini --reload
diff --git a/docs/tutorials/wiki2/tests.rst b/docs/tutorials/wiki2/tests.rst
index 97508168e..e923ff9cb 100644
--- a/docs/tutorials/wiki2/tests.rst
+++ b/docs/tutorials/wiki2/tests.rst
@@ -87,7 +87,7 @@ On UNIX:
On Windows:
-.. code-block:: ps1con
+.. code-block:: doscon
c:\pyramidtut\tutorial> %VENV%\Scripts\py.test -q