Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 6549a59

Browse files
committed
Review edits of install.rst
1 parent 4f0408d commit 6549a59

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

‎doc/sphinx/source/install.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@ This project is primarily
2424
`a documentation project <http://pythonextensionpatterns.readthedocs.org/en/latest/index.html>`_
2525
however it does contain a lot of code examples and tests.
2626

27+
Project Links
28+
=============
29+
30+
- Source is `on GitHub <https://github.com/paulross/PythonExtensionPatterns>`_.
31+
- Documentation `Read the Docs <http://pythonextensionpatterns.readthedocs.org/en/latest/index.html>`_.
32+
- Project is `on PyPi <https://pypi.org/project/cPyExtPatt/>`_.
33+
2734
This code can be installed as follows.
2835

2936
Setup
@@ -197,13 +204,14 @@ Building Everything
197204

198205
At the project root there is a script ``build_all.sh`` which, for every supported version of Python:
199206

200-
- Creates a Python virtual environment (deleting any existing one).
201-
- Run ``pip install -r requirements.txt`` onn the virtual environment.
207+
- Builds and tests the C/C++ code.
208+
- Creates a Python virtual environment (optionally deleting any existing one).
209+
- Run ``pip install -r requirements.txt`` on the virtual environment.
202210
- Run ``python setup.py develop`` in that virtual environment.
203211
- Run ``pytest tests/``.
204212
- Run ``python setup.py bdist_wheel``.
205213
- Run ``python setup.py sdist``.
206-
- Create the documentation.
214+
- Optionally, create the documentation.
207215
- Report the results.
208216

209217
The script will halt on the first error returning the error code.

‎doc/sphinx/source/introduction.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,8 +162,6 @@ There are common drawbacks of code generators:
162162

163163
There are many other alternatives such as ``pypy``, ``numba`` that are worth knowing about.
164164

165-
.. _introduction_summary_advice:
166-
167165
------------------------------------
168166
A Faustian Bargain
169167
------------------------------------
@@ -180,6 +178,8 @@ quirks, to have any chance of being compatible with existing code.
180178
Python C extensions will be around for a long time.
181179
It is a skill worth learning.
182180

181+
.. _introduction_summary_advice:
182+
183183
------------------------------------
184184
Summary Advice
185185
------------------------------------

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /