Browse Source

Docs fixes

Thomas Kluyver 7 years ago
parent
commit
56db53f1a7
4 changed files with 15 additions and 16 deletions
  1. 2 2
      README.rst
  2. 1 3
      doc/api/main.rst
  3. 7 6
      doc/index.rst
  4. 5 5
      doc/releasenotes.rst

+ 2 - 2
README.rst

@@ -1,8 +1,8 @@
-pynsist is a tool to build Windows installers for your Python applications. The
+Pynsist is a tool to build Windows installers for your Python applications. The
 installers bundle Python itself, so you can distribute your application to
 people who don't have Python installed.
 
-At present, pynsist requires Python 3.3 or above, or Python 2.7.
+Pynsist requires Python 3.5 or above.
 
 For more information, see `the documentation <https://pynsist.readthedocs.io/en/latest/>`_
 and `the examples <https://github.com/takluyver/pynsist/tree/master/examples>`_.

+ 1 - 3
doc/api/main.rst

@@ -7,9 +7,7 @@ Building installers
    
    .. automethod:: run
 
-   .. automethod:: fetch_python
-
-   .. automethod:: fetch_pylauncher
+   .. automethod:: fetch_python_embeddable
 
    .. automethod:: write_script
 

+ 7 - 6
doc/index.rst

@@ -1,11 +1,11 @@
 pynsist |version|
 =================
 
-pynsist is a tool to build Windows installers for your Python applications. The
+Pynsist is a tool to build Windows installers for your Python applications. The
 installers bundle Python itself, so you can distribute your application to
 people who don't have Python installed.
 
-At present, pynsist requires Python 3.3 or above, or Python 2.7.
+Pynsist requires Python 3.5 or above.
 
 Quickstart
 ----------
@@ -28,10 +28,11 @@ Quickstart
        version=3.4.0
 
        [Include]
-       # Importable packages that your application requires, one per line
-       packages = requests
-            bs4
-            html5lib
+       # Packages from PyPI that your application requires, one per line
+       # These must have wheels on PyPI:
+       pypi_wheels = requests==2.18.4
+            beautifulsoup4==4.6.0
+            html5lib==0.999999999
 
        # Other files and folders that should be installed
        files = LICENSE

+ 5 - 5
doc/releasenotes.rst

@@ -42,8 +42,8 @@ Version 1.10
 Version 1.9
 -----------
 
-* When building an installer with Python 3.6 or above, :ref:`bundled Python
-  <python_bundled>` is now the default. For Python up to 3.5, 'installer' remains
+* When building an installer with Python 3.6 or above, bundled Python
+  is now the default. For Python up to 3.5, 'installer' remains
   the default format. You can override the default by specifying ``format`` in
   the :ref:`cfg_python` of the config file.
 * The C Runtime needed for bundled Python is now installed 'app-local', rather
@@ -65,7 +65,7 @@ Version 1.8
 * Fixed a bug with fetching a wheel when another version of the same package
   is already cached.
 * Fixed a bug in extracting files from certain wheels.
-* Installers using :ref:`bundled Python <python_bundled>` may need a Windows
+* Installers using bundled Python may need a Windows
   update package for the Microsoft C runtime. They now download this from the
   `RawGit <https://rawgit.com/>`__ CDN, rather than hitting GitHub directly.
 * If the Windows update package fails to install, an error message will be
@@ -84,8 +84,8 @@ Version 1.7
 Version 1.6
 -----------
 
-* Experimental support for creating installers that :ref:`bundle Python with the
-  application <python_bundled>`.
+* Experimental support for creating installers that bundle Python with the
+  application.
 * Support for Python 3.5 installers.
 * The user agent is set when downloading Python builds, so downloads from
   Pynsist can be identified.