docs fixes: get working again

* fix moving of rules_for_contributors to CONTRIBUTING.md
  made in 99cacc3 which broke the docs
* remove easy_install reference, deprecated
* fix invalid syntax errors

doc/source/conf.py

@@ -45,13 +45,14 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.doctest",
     "sphinx.ext.viewcode",
+    "myst_parser",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = ".rst"
+source_suffix = [".rst", ".md"]
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'

doc/source/contributing.rst

@@ -0,0 +1,5 @@
+Contributing
+============
+
+```{include} ../CONTRIBUTING.md
+```

doc/source/index.rst

@@ -24,8 +24,7 @@ Sections
    api
    artifact
    build
-   using_jenkinsapi
-   rules_for_contributors
+   contributing
 
 Important Links
 ---------------
@@ -53,14 +52,8 @@ Most users can do the following:
 
     pip install jenkinsapi
 
-Or..
-
-.. code-block:: bash
-
-    easy_install jenkinsapi
-
  * In Jenkins > 1.518 you will need to disable "Prevent Cross Site Request Forgery exploits".
- * Remember to set the Jenkins Location in general settings - Jenkins' REST web-interface will not work if this is set incorrectly.
+ * Remember to set the Jenkins Location in general settings - Jenkins REST web-interface will not work if this is set incorrectly.
 
 Examples
 --------

jenkinsapi/build.py

@@ -527,8 +527,7 @@ def get_estimated_duration(self) -> int | None:
     def stop(self) -> bool:
         """
         Stops the build execution if it's running
-        :return boolean True if succeded False otherwise or the build
-            is not running
+        :return: boolean True if succeeded False otherwis
         """
         if self.is_running():
             url: str = "%s/stop" % self.baseurl

test-requirements.txt

@@ -6,6 +6,7 @@ astroid>=1.4.8
 pylint>=1.7.1
 tox>=2.3.1
 mock
+myst-parser
 codecov
 requests_kerberos
 flake8