remove build_sphinx and upload_docs, fixes #

ThomasWaldmann · ThomasWaldmann · commit a8c03fecd795 · 2023-05-21T02:32:53.000+02:00
build_sphinx is removed since sphinx 7. upload_docs does not work since long due to missing permissions, see python-llfuse#59. the removed fix_docutils bug workaround is not needed any more: sphinx-doc/sphinx#1154
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -35,7 +35,7 @@ jobs:
           sudo apt-get install -y libfuse-dev
 
       - name: Install Python dependencies (misc)
-        run: pip install pytest "sphinx<7.0"
+        run: pip install pytest sphinx
 
       - name: Install Python dependencies (Cython 0.29)
         if: ${{ matrix.cython-version == '0.29' }}
diff --git a/developer-notes/release-process.md b/developer-notes/release-process.md
@@ -6,16 +6,15 @@
 
 # Releasing a new version #
  * `export DEVELOPER_MODE=0`  # or just not have it set
- * Bump version in `setup.py`
+ * Bump version in `setup.py` and version/release in `rst/conf.py`
  * Add release date to `Changes.rst`
  * Check `git status` to avoid undesired files in the tarball.
  * `./setup.py build_cython`
  * `./setup.py sdist`
  * Extract tarball in temporary directory,
     * `./setup.py build_ext --inplace && python3 -m pytest test`
     * Run tests under valgrind. Build python `--with-valgrind --with-pydebug`, then `valgrind --trace-children=yes "--trace-children-skip=*mount*" python-dbg -m pytest test/`
-    * `./setup.py build_sphinx`
-    * `./setup.py upload_docs`
+    * `sphinx-build -b html rst doc/html`
  * `./util/sdist-sign 1.2.3`  # use real version number, have GPG ready
  * `./util/upload-pypi 1.2.3`  # use real version number, have twine installed
  * git commit, git tag -s
diff --git a/rst/conf.py b/rst/conf.py
@@ -52,16 +52,16 @@
 
 # General information about the project.
 project = 'Python-LLFUSE'
-copyright = '2010-2015, Nikolaus Rath'
+copyright = '2010-2023, Nikolaus Rath'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '1.0'
+version = '1.4.4'
 # The full version, including alpha/beta/rc tags.
-release = '1.0'
+release = version + ''
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -74,7 +74,7 @@
 #today_fmt = '%B %d, %Y'
 
 # List of documents that shouldn't be included in the build.
-unused_docs = [ ]
+unused_docs = []
 
 # List of directories, relative to source directory, that shouldn't be searched
 # for source files.
diff --git a/rst/install.rst b/rst/install.rst
@@ -68,7 +68,7 @@ necessary commands are::
   python setup.py build_cython
   python setup.py build_ext --inplace
   python -m pytest test/
-  python setup.py build_sphinx
+  sphinx-build -b html rst doc/html
   python setup.py install
 
 
diff --git a/setup.cfg b/setup.cfg
@@ -1,3 +0,0 @@
-[build_sphinx]
-source-dir = rst
-build-dir  = doc
diff --git a/setup.py b/setup.py
@@ -44,25 +44,13 @@
 if DEVELOPER_MODE:
     print('running in developer mode')
     warnings.resetwarnings()
-    # We can't use `error`, because e.g. Sphinx triggers a
-    # DeprecationWarning.
     warnings.simplefilter('default')
 
-# Add src to load path, important for Sphinx autodoc
-# to work properly
-sys.path.insert(0, os.path.join(basedir, 'src'))
 
 LLFUSE_VERSION = '1.4.4'
 
 def main():
 
-    try:
-        from sphinx.application import Sphinx #pylint: disable-msg=W0612
-    except ImportError:
-        pass
-    else:
-        fix_docutils()
-
     with open(os.path.join(basedir, 'README.rst')) as fh:
         long_desc = fh.read()
 
@@ -143,13 +131,7 @@ def main():
           ext_modules=[Extension('llfuse', c_sources,
                                   extra_compile_args=compile_args,
                                   extra_link_args=link_args)],
-        cmdclass={'upload_docs': upload_docs,
-                  'build_cython': build_cython },
-          command_options={
-            'build_sphinx': {
-                'version': ('setup.py', LLFUSE_VERSION),
-                'release': ('setup.py', LLFUSE_VERSION),
-            }},
+          cmdclass={'build_cython': build_cython},
           )
 
 
@@ -184,21 +166,6 @@ def pkg_config(pkg, cflags=True, ldflags=False, min_ver=None):
     return cflags.decode('us-ascii').split()
 
 
-class upload_docs(setuptools.Command):
-    user_options = []
-    boolean_options = []
-    description = "Upload documentation"
-
-    def initialize_options(self):
-        pass
-
-    def finalize_options(self):
-        pass
-
-    def run(self):
-        subprocess.check_call(['rsync', '-aHv', '--del', os.path.join(basedir, 'doc', 'html') + '/',
-                               'ebox.rath.org:/srv/www.rath.org/llfuse-docs/'])
-
 class build_cython(setuptools.Command):
     user_options = []
     boolean_options = []
@@ -238,30 +205,6 @@ def run(self):
                     if subprocess.call(cmd + [path + '.pyx']) != 0:
                         raise SystemExit('Cython compilation failed')
 
-def fix_docutils():
-    '''Work around https://bitbucket.org/birkenfeld/sphinx/issue/1154/'''
-
-    import docutils.parsers
-    from docutils.parsers import rst
-    old_getclass = docutils.parsers.get_parser_class
-
-    # Check if bug is there
-    try:
-        old_getclass('rst')
-    except AttributeError:
-        pass
-    else:
-        return
-
-    def get_parser_class(parser_name):
-        """Return the Parser class from the `parser_name` module."""
-        if parser_name in ('rst', 'restructuredtext'):
-            return rst.Parser
-        else:
-            return old_getclass(parser_name)
-    docutils.parsers.get_parser_class = get_parser_class
-
-    assert docutils.parsers.get_parser_class('rst') is rst.Parser
 
 if __name__ == '__main__':
     main()
diff --git a/test/ci-test.sh b/test/ci-test.sh
@@ -6,4 +6,4 @@ python setup.py build_cython
 python setup.py build_ext --inplace
 python -m pytest test/
 
-python setup.py build_sphinx
+sphinx-build -b html rst doc/html

Original file line number	Diff line number	Diff line change
`@@ -1,3 +0,0 @@`
`1`		`-[build_sphinx]`
`2`		`-source-dir = rst`
`3`		`-build-dir = doc`