Move documentation from GH Pages to Read the Docs

Author: mrbean-bremen

.github/PULL_REQUEST_TEMPLATE/code_pr.md renamed to .github/PULL_REQUEST_TEMPLATE.md

@@ -1,8 +1,3 @@
----
-name: Bug fix or feature implementation
-about: Create a pull request for changed code
----
-
 <!--
 Please prefix your PR title with [WIP] for PRs that are still in progress.
 -->
@@ -16,3 +11,5 @@ The related issue or a description of the bug or feature that this PR addresses.
 - [ ] Entry to release notes added
 - [ ] Linter and mypy show no errors
 - [ ] Unit tests passing
+- [ ] For documentation changes: The Read the Docs preview builds and looks 
+  as expected

.github/PULL_REQUEST_TEMPLATE/documentation_pr.md

@@ -28,38 +28,10 @@ jobs:
         python -m pip install --upgrade pip
         python -m pip install build
         cd main
-        echo "RELEASE_VERSION=$(cat pyfakefs/_version.py | cut -d "'" -f 2)" >> $GITHUB_ENV
         python -m build
 
     - name: Publish package to PyPI
       uses: pypa/gh-action-pypi-publish@master
       with:
         user: __token__
         password: ${{ secrets.PYPI_TOKEN }}
-
-    - name: Create release docs
-      run: |
-        python -m pip install wheel
-        python -m pip install pytest
-        python -m pip install sphinx
-        cd main/docs
-        make html
-
-    - name: Checkout gh-pages
-      uses: actions/checkout@v2
-      with:
-        ref: gh-pages
-        path: doc
-
-    - name: Copy and commit release documentation
-      run: |
-        cp -r main/gh-pages/* doc/release
-        cd doc
-        sed "s/href=\"release\/index.html\">Pyfakefs .*/href=\"release\/index.html\">Pyfakefs $RELEASE_VERSION/" index.html > index1.html
-        rm index.html
-        mv index1.html index.html
-        git config user.name "CI Build"
-        git config user.email "[email protected]"
-        git add release/*
-        git commit -a -m "Release $RELEASE_VERSION documentation"
-        git push

.github/workflows/builddocs.yml

@@ -12,7 +12,8 @@ New version after the transfer to `pytest-dev`.
 ### Infrastructure
 * transferred the repository to the `pytest-dev` organization
 * renamed the `master` branch to `main`
-* added automatic PyPI release workflow 
+* added automatic PyPI release workflow
+* move documentation from GitHub Pages to Read the Docs 
 
 ### New Features
 * added some support for `st_blocks` in stat result

.github/workflows/release-deploy.yml

@@ -46,9 +46,9 @@ If you want to improve the existing documentation, you can do this also using a
 You can contribute to:
   * the source code documentation using [Google documentation style](https://google.github.io/styleguide/pyguide.html) 
   * the [README](https://github.com/pytest-dev/pyfakefs/blob/main/README.md) using [markdown syntax](https://help.github.com/articles/basic-writing-and-formatting-syntax/)
-  * the documentation published on [GitHub Pages](http://pytest-dev.github.io/pyfakefs/),
-   located in the `docs` directory (call `make html` from that directory). 
-  For building the documentation, you will need [sphinx](http://sphinx.pocoo.org/).
+  * the documentation published on [Read the Docs](https://pytest-pyfakefs.readthedocs.io/en/latest/),
+    located in the `docs` directory (call `make html` from that directory). 
+    For building the documentation, you will need [sphinx](http://sphinx.pocoo.org/).
   * [this file](https://github.com/pytest-dev/pyfakefs/blob/main/CONTRIBUTING.md) 
   if you want to enhance the contributing guide itself
 

CHANGES.md

@@ -1,4 +1,5 @@
-# pyfakefs [![PyPI version](https://badge.fury.io/py/pyfakefs.svg)](https://badge.fury.io/py/pyfakefs) [![Python version](https://img.shields.io/pypi/pyversions/pyfakefs.svg)](https://img.shields.io/pypi/pyversions/pyfakefs.svg) ![Testsuite](https://github.com/pytest-dev/pyfakefs/workflows/Testsuite/badge.svg)
+# pyfakefs [![PyPI version](https://badge.fury.io/py/pyfakefs.svg)](https://badge.fury.io/py/pyfakefs) [![Python version](https://img.shields.io/pypi/pyversions/pyfakefs.svg)](https://img.shields.io/pypi/pyversions/pyfakefs.svg) ![Testsuite](https://github.com/pytest-dev/pyfakefs/workflows/Testsuite/badge.svg) [![Documentation Status](https://readthedocs.org/projects/pytest-pyfakefs/badge/?version=latest)](https://pytest-pyfakefs.readthedocs.io/en/latest/?badge=latest)
+
 
 pyfakefs implements a fake file system that mocks the Python file system modules.
 Using pyfakefs, your tests operate on a fake file system in memory without
@@ -16,14 +17,14 @@ pyfakefs works with current versions of Linux, Windows and macOS.
 
 This document provides a general overview for pyfakefs.  There is more:
 
-* The documentation at [GitHub Pages:](http://pytest-dev.github.io/pyfakefs)
-  * The [Release documentation](http://pytest-dev.github.io/pyfakefs/release)
+* The documentation at **Read the Docs**:
+  * The [Release documentation](https://pytest-pyfakefs.readthedocs.io/en/stable)
     contains usage documentation for pyfakefs and a description of the 
     most relevant classes, methods and functions for the last version 
     released on PyPI
-  * The [Development documentation](http://pytest-dev.github.io/pyfakefs/main)
+  * The [Development documentation](https://pytest-pyfakefs.readthedocs.io/en/latest)
     contains the same documentation for the current main branch
-  * The [Release 3.7 documentation](http://pytest-dev.github.io/pyfakefs/release37)
+  * The [Release 3.7 documentation](https://pytest-pyfakefs.readthedocs.io/en/v3.7.2/)
     contains usage documentation for the last version of pyfakefs 
     supporting Python 2.7
 * The [Release Notes](https://github.com/pytest-dev/pyfakefs/blob/main/CHANGES.md) 

CONTRIBUTING.md

@@ -36,6 +36,7 @@
     openpyxl = None
 
 
+@unittest.skipIf(IS_PYPY, "Has a problem with current PyPy")
 class TestPatchedPackages(fake_filesystem_unittest.TestCase):
     def setUp(self):
         self.setUpPyfakefs()
@@ -47,15 +48,13 @@ def test_read_csv(self):
             df = pd.read_csv(path)
             assert (df.columns == ['1', '2', '3', '4']).all()
 
-        @unittest.skipIf(IS_PYPY, "Has a problem with current PyPy")
         def test_read_table(self):
             path = '/foo/bar.csv'
             self.fs.create_file(path, contents='1|2|3|4')
             df = pd.read_table(path, delimiter='|')
             assert (df.columns == ['1', '2', '3', '4']).all()
 
     if pd is not None and xlrd is not None:
-        @unittest.skipIf(IS_PYPY, "Has a problem with current PyPy")
         def test_read_excel(self):
             path = '/foo/bar.xlsx'
             src_path = os.path.dirname(os.path.abspath(__file__))
@@ -67,7 +66,6 @@ def test_read_excel(self):
             assert (df.columns == [1, 2, 3, 4]).all()
 
     if pd is not None and openpyxl is not None:
-        @unittest.skipIf(IS_PYPY, "Has a problem with current PyPy")
         def test_write_excel(self):
             self.fs.create_dir('/foo')
             path = '/foo/bar.xlsx'