Merge branch 'goodbye-initd'

.travis.yml

@@ -20,5 +20,11 @@ install:
 script:
   - scripts/travis_test.sh
 
+deploy:
+  - provider: script
+    script: bash scripts/travis_update_docs.sh
+    on:
+      branch: master
+
 notifications:
   email: false

INSTALL

@@ -1,4 +1,4 @@
 Installation instructions are included in the docs.
 
 Please check the 'doc/src/install.rst' file or online at
-<http://initd.org/psycopg/docs/install.html>.
+<https://www.psycopg.org/docs/install.html>.

Makefile

@@ -42,7 +42,7 @@ endif
 VERSION := $(shell grep PSYCOPG_VERSION setup.py | head -1 | sed -e "s/.*'\(.*\)'/\1/")
 SDIST := dist/psycopg2-$(VERSION).tar.gz
 
-.PHONY: env check clean
+.PHONY: check clean
 
 default: package
 

README.rst

@@ -23,11 +23,13 @@ Documentation
 
 Documentation is included in the ``doc`` directory and is `available online`__.
 
-.. __: http://initd.org/psycopg/docs/
+.. __: https://www.psycopg.org/docs/
 
 For any other resource (source code repository, bug tracker, mailing list)
 please check the `project homepage`__.
 
+.. __: https://psycopg.org/
+
 
 Installation
 ------------
@@ -56,11 +58,8 @@ production it is advised to use the package built from sources.
 
 .. _PyPI: https://pypi.org/project/psycopg2/
 .. _psycopg2-binary: https://pypi.org/project/psycopg2-binary/
-.. _install: http://initd.org/psycopg/docs/install.html#install-from-source
-.. _faq: http://initd.org/psycopg/docs/faq.html#faq-compile
-
-.. __: http://initd.org/psycopg/
-
+.. _install: https://www.psycopg.org/docs/install.html#install-from-source
+.. _faq: https://www.psycopg.org/docs/faq.html#faq-compile
 
 :Linux/OSX: |travis|
 :Windows: |appveyor|

doc/Makefile

@@ -1,4 +1,4 @@
-.PHONY: env help clean html doctest
+.PHONY: env help clean html package doctest
 
 docs: html
 
@@ -9,26 +9,25 @@ check: doctest
 
 PYTHON := python$(PYTHON_VERSION)
 PYTHON_VERSION ?= $(shell $(PYTHON) -c 'import sys; print ("%d.%d" % sys.version_info[:2])')
+BUILD_DIR = $(shell pwd)/../build/lib.$(PYTHON_VERSION)
 
 SPHINXBUILD ?= $$(pwd)/env/bin/sphinx-build
 SPHOPTS = SPHINXBUILD=$(SPHINXBUILD)
 
-html: src/sqlstate_errors.rst
-	$(MAKE) PYTHON=$(PYTHON) -C .. package
+html: package src/sqlstate_errors.rst
 	$(MAKE) $(SPHOPTS) -C src $@
 	cp -r src/_build/html .
 
-src/sqlstate_errors.rst: ../psycopg/sqlstate_errors.h
+src/sqlstate_errors.rst: ../psycopg/sqlstate_errors.h $(BUILD_DIR)
 	env/bin/python src/tools/make_sqlstate_docs.py $< > $@
 
+$(BUILD_DIR):
+	$(MAKE) PYTHON=$(PYTHON) -C .. package
+
 doctest:
 	$(MAKE) PYTHON=$(PYTHON) -C .. package
 	$(MAKE) $(SPHOPTS) -C src $@
 
-upload:
-	# this command requires ssh configured to the proper target
-	tar czf - -C html . | ssh psycoweb tar xzvf - -C docs/current
-
 clean:
 	$(MAKE) $(SPHOPTS) -C src $@
 	rm -rf html src/sqlstate_errors.rst

doc/README.rst

@@ -6,7 +6,7 @@ introspection, so you will need the same prerequisites_.  The only extra
 prerequisite is virtualenv_: the packages needed to build the docs will be
 installed when building the env.
 
-.. _prerequisites: http://initd.org/psycopg/docs/install.html#install-from-source
+.. _prerequisites: https://www.psycopg.org/docs/install.html#install-from-source
 .. _virtualenv: https://virtualenv.pypa.io/en/latest/
 
 Build the env once with::

doc/release.rst

@@ -13,7 +13,7 @@ How to make a psycopg2 release
   In the rest of this document we assume you have exported the version number
   into an environment variable, e.g.::
 
-    $ export VERSION=2.7
+    $ export VERSION=2.8.4
 
 - In the `Travis settings`__ you may want to be sure that the variables
   ``TEST_PAST`` and ``TEST_FUTURE`` are set to 1 to check all
@@ -36,45 +36,37 @@ How to make a psycopg2 release
 - Create a signed tag with the content of the relevant NEWS bit and push it.
   E.g.::
 
-    $ git tag -a -s 2_7
+    $ git tag -a -s 2_8_4
 
-    Psycopg 2.7 released
+    Psycopg 2.8.4 released
 
-    What's new in psycopg 2.7
-    -------------------------
+    What's new in psycopg 2.8.4
+    ---------------------------
 
     New features:
 
-    - Added `~psycopg2.sql` module to generate SQL dynamically (:ticket:`#308`).
+    - Fixed bug blah (:ticket:`#42`).
     ...
 
 - Update the `psycopg2-wheels`_ submodule to the tag version and push. This
   will build the packages on `Travis CI`__ and `AppVeyor`__ and upload them to
-  the `initd.org upload`__ dir.
+  http://upload.psycopg.org/.
 
 .. _psycopg2-wheels: https://github.com/psycopg/psycopg2-wheels
 .. __: https://travis-ci.org/psycopg/psycopg2-wheels
 .. __: https://ci.appveyor.com/project/psycopg/psycopg2-wheels
-.. __: http://initd.org/psycopg/upload/
 
 - Download the packages generated (this assumes ssh configured properly)::
 
-    $ rsync -arv initd-upload:psycopg2-${VERSION} .
+    $ rsync -arv psycopg-upload:psycopg2-${VERSION} .
 
 - Sign the packages and upload the signatures back::
 
     $ for f in psycopg2-${VERSION}/*.{exe,tar.gz,whl}; do \
         gpg --armor --detach-sign $f;
       done
 
-    $ rsync -arv psycopg2-${VERSION} initd-upload:
-
-- Run the ``copy-tarball.sh`` script on the server to copy the uploaded files
-  in the `tarballs`__ dir::
-
-    $ ssh [email protected] copy-tarball.sh ${VERSION}
-
-.. __: http://initd.org/psycopg/tarballs/
+    $ rsync -arv psycopg2-${VERSION} psycopg-upload:
 
 - Remove the ``.exe`` from the dir, because we don't want to upload them on
   PyPI::
@@ -88,7 +80,7 @@ How to make a psycopg2 release
 - Create a release and release notes in the psycopg website, announce to
   psycopg and pgsql-announce mailing lists.
 
-- Edit ``setup.py`` changing the version again (e.g. go to ``2.7.1.dev0``).
+- Edit ``setup.py`` changing the version again (e.g. go to ``2.8.5.dev0``).
 
 
 Releasing test packages

doc/requirements.txt

@@ -1,6 +1,7 @@
 # Packages only needed to build the docs
 Pygments>=2.2,<2.3
 Sphinx>=1.6,<=1.7
+sphinx-better-theme>=0.1.5,<0.2
 
 # 0.15.2 affected by https://sourceforge.net/p/docutils/bugs/353/
 # Can update to 0.16 after release (currently in rc) but must update Sphinx too

doc/src/_static/psycopg.css

@@ -1,5 +1,3 @@
-@import url("classic.css");
-
 blockquote {
     font-style: italic;
 }
@@ -37,3 +35,102 @@ dl.faq dt {
 table.data-types div.line-block {
     margin-bottom: 0;
 }
+
+
+/* better theme customisation */
+
+body {
+    background-color: #216464;
+}
+
+header, .related, .document, footer {
+    background-color: white;
+}
+
+header h1 {
+    font-size: 150%;
+    margin-bottom: 0;
+    padding: 0.5rem 10px 0.5rem 10px;
+}
+
+h1, h2, h3 {
+    font-weight: normal;
+}
+
+.body h1, .body h2, .body h3 {
+    color: #074848;
+}
+
+h1 {
+    font-size: 200%;
+}
+
+h2 {
+    font-size: 160%;
+}
+
+h3 {
+    font-size: 140%;
+}
+
+footer#pagefooter {
+    margin-bottom: 1rem;
+    font-size: 85%;
+    color: #444;
+}
+
+#rellinks, #breadcrumbs {
+    padding-right: 10px;
+    padding-left: 10px;
+}
+
+.sphinxsidebar {
+    padding-left: 10px;
+}
+
+.bodywrapper {
+    padding-right: 10px;
+}
+
+div.body h1, div.body h2, div.body h3 {
+    background-color: #f2f2f2;
+    border-bottom: 1px solid #d0d0d0;
+}
+
+div.body p.rubric {
+    border-bottom: 1px solid #d0d0d0;
+}
+
+body .sphinxsidebar .search {
+    margin-top: 0;
+}
+
+html pre {
+    background-color: #efc;
+    border: 1px solid #ac9;
+    border-left: none;
+    border-right: none;
+}
+
+a, a:visited {
+    color: #0b6868;
+}
+
+th {
+    background-color: #ede;
+}
+
+code.xref, a code {
+    font-weight: bold;
+}
+
+code.descname {
+    font-weight: bold;
+    font-size: 120%;
+}
+
+@media (max-width: 820px) {
+    body {
+        background-color: white;
+    }
+}

doc/src/_templates/layout.html

@@ -0,0 +1,14 @@
+{# Override the sphinx theme for the docs to add analytics #}
+
+{%- extends "!layout.html" %}
+
+{%- block scripts %}
+    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-19287248-2"></script>
+    <script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+      gtag('config', 'UA-19287248-2');
+    </script>
+    {{- super() }}
+{%- endblock %}

doc/src/_templates/searchbox.html

@@ -0,0 +1,6 @@
+{# Add a title over the search box #}
+
+{%- if pagename != "search" %}
+<h3>Quick search</h3>
+{%- include "!searchbox.html" %}
+{%- endif %}