diff --git a/doc/source/conf.py b/doc/source/conf.py index 0384b71b..3f10af3e 100644 --- a/doc/source/conf.py +++ b/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' diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst new file mode 100644 index 00000000..2232a542 --- /dev/null +++ b/doc/source/contributing.rst @@ -0,0 +1,5 @@ +Contributing +============ + +```{include} ../CONTRIBUTING.md +``` diff --git a/doc/source/index.rst b/doc/source/index.rst index 6389db22..cfa6dcf7 100644 --- a/doc/source/index.rst +++ b/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 -------- diff --git a/jenkinsapi/build.py b/jenkinsapi/build.py index 3134d521..5e8d97e0 100644 --- a/jenkinsapi/build.py +++ b/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 diff --git a/test-requirements.txt b/test-requirements.txt index 0d07d562..efc2b376 100644 --- a/test-requirements.txt +++ b/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