use read the docs and sphinx

.gitignore

@@ -129,7 +129,7 @@ dmypy.json
 .pyre/
 
 *.*~
-docs/build/
+docs/_build/
 build/
 .ctags
 tags

.readthedocs.yaml

@@ -0,0 +1,9 @@
+version: 2
+
+python:
+  version: "3.7"
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs 

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,60 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "rope"
+copyright = "2022, Ali Gholami Rudi"
+author = "Ali Gholami Rudi"
+
+# The full version, including alpha/beta/rc tags
+release = "1.0.0"
+
+
+# -- General configuration ---------------------------------------------------
+
+pygments_style = "sphinx"
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx_autodoc_typehints",
+    "pytoolconfig.documentation",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+# html_theme = "alablaster"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]

docs/configuration.rst

@@ -0,0 +1,49 @@
+Configuration
+=============
+Rope supports the following configuration formats
+
+1. pyproject.toml
+2. config.py 
+
+pyproject.toml 
+--------------
+Will be used if [tool.rope] is configured.
+
+.. code-block:: toml 
+   
+    [tool.rope]
+    compress_objectdb = true
+
+config.py 
+---------
+You can also configure rope via a config.py in the ropefolder directory.  
+
+.. code-block:: python3
+    
+    def set_prefs(prefs):
+        prefs["ignored_resources"] = [
+            "*.pyc",
+            "*~",
+            ".ropeproject",
+            ".hg",
+            ".svn",
+            "_svn",
+            ".git",
+            ".tox",
+            ".venv",
+            "venv",
+        ]
+
+Additionally, you can run an executable function at startup of rope. 
+
+.. code-block:: python3 
+   
+    def project_opened(project):
+        """This function is called after opening the project"""
+        # Do whatever you like here!
+ 
+
+Options
+-------
+.. autopytoolconfigtable:: rope.base.config.RopePrefs
+

docs/index.rst

@@ -0,0 +1,28 @@
+.. rope documentation master file, created by
+   sphinx-quickstart on Sat May 21 18:16:44 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to rope's documentation!
+================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   overview
+   rope 
+   library
+   configuration
+   contributing
+   release-process
+   dev/issues
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/release-process.rst

@@ -1,3 +1,6 @@
+Release Process
+===============
+
 1. Ensure tickets assigned to Milestones are up to date 
 2. Update CHANGELOG.md
 3. Increment version number in ``rope/__init__.py``

setup.py

@@ -70,11 +70,17 @@ def get_version():
     license="LGPL-3.0-or-later",
     classifiers=classifiers,
     extras_require={
+        "doc": [
+            "pytoolconfig[doc]",
+            "sphinx>=4.5.0",
+            "sphinx-autodoc-typehints>=1.18.1",
+            "sphinx-rtd-theme>=1.0.0",
+        ],
         "dev": [
             "build",
             "pytest",
             "pytest-timeout",
-        ]
+        ],
     },
     python_requires=">=3.7",
 )