Move contributing docs to sphinx.

fkdosilovic · fkdosilovic · commit 58a2be793e58 · 2024-12-14T00:36:06.000+01:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,26 +1,3 @@
 # How to contribute
 
-## Preparing the development setup
-
-1. Install Python 3.9
-
-```bash
-sudo add-apt-repository ppa:deadsnakes/ppa
-sudo apt update
-sudo apt install python3.9 python3.9-venv
-```
-
-2. Clone the repo, create and activate a new virtual environment
-
-```bash
-cd judge0-python
-python3.9 -m venv venv
-source venv/bin/activate
-```
-
-3. Install the library and development dependencies
-
-```bash
-pip install -e .[test]
-pre-commit install
-```
+See [docs](https://judge0.github.io/judge0-python/contributing.html).
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
@@ -0,0 +1,28 @@
+Contributing
+============
+
+Preparing the development setup
+-------------------------------
+
+1. Install Python 3.9
+
+.. code-block:: console
+
+    $ sudo add-apt-repository ppa:deadsnakes/ppa
+    $ sudo apt update
+    $ sudo apt install python3.9 python3.9-venv
+
+2. Clone the repo, create and activate a new virtual environment
+
+.. code-block:: console
+
+    $ cd judge0-python
+    $ python3.9 -m venv venv
+    $ . venv/bin/activate
+
+3. Install the library and development dependencies
+
+.. code-block:: console
+
+    $ pip install -e .[test]
+    $ pre-commit install
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,13 +1,9 @@
-.. Judge0 Python SDK documentation master file, created by
-   sphinx-quickstart on Thu Dec 12 19:59:23 2024.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Judge0 Python SDK documentation
 ===============================
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents
 
-   api_index
+   api_index
+   contributing
