Skip to content

Commit ce22334

Browse files
committed
Remove reference to readme_renderer
And add a note about psycopg2 requirements to getting started doc.
1 parent bb62ae7 commit ce22334

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

docs/development/getting-started.rst

+5
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,11 @@ run all of the needed services. The Warehouse repository will be mounted inside
148148
the Docker container at :file:`/opt/warehouse/src/`. After the initial build,
149149
you should not have to run this command again.
150150

151+
.. note::
152+
153+
On some systems ``make build`` may require the prior installation of libpq
154+
and its headers so that psycopg2 can be compiled and installed.
155+
151156

152157
.. _running-warehouse-containers:
153158

warehouse/templates/pages/help.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -628,8 +628,8 @@ <h2>{% trans %}Troubleshooting{% endtrans %}</h2>
628628

629629
<h3 id="description-render-failure">{{ description_render_failure() }}</h3>
630630
<p>
631-
{% trans trimmed readme_renderer_href='https://pypi.org/project/readme_renderer/', twine_check_href='https://twine.readthedocs.io/en/latest/#twine-check', title=gettext('External link') %}
632-
PyPI will reject uploads if the package description fails to render. You may <a href="{{ twine_check_href }}" title="{{ title }}">use twine's check command</a> or <a href="{{ readme_renderer_href }}">readme_renderer</a>, the same description renderer used by PyPI, to locally check a description for validity.
631+
{% trans trimmed href='https://twine.readthedocs.io/en/latest/#twine-check', title=gettext('External link') %}
632+
PyPI will reject uploads if the package description fails to render. You may <a href="{{ href }}" title="{{ title }}">use twine's check command</a> to locally check a description for validity.
633633
{% endtrans %}
634634
</p>
635635

0 commit comments

Comments
 (0)