From 26706d5a8075bcac20227919da337b051ac571e3 Mon Sep 17 00:00:00 2001 From: Rotzbua Date: Thu, 2 Nov 2023 14:33:57 +0100 Subject: [PATCH] docs: rst format --- CONTRIBUTING.rst | 2 +- documentation/src/api_architecture.rst | 2 +- documentation/src/index.rst | 2 -- documentation/src/install.rst | 2 +- 4 files changed, 3 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8939da80f..e5b46653f 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -141,7 +141,7 @@ perfect. We can work on it together. Running the Code ---------------------------- -To serve website, run `scripts/boxesserver` script +To serve website, run :code:`scripts/boxesserver` script. Reporting bugs -------------- diff --git a/documentation/src/api_architecture.rst b/documentation/src/api_architecture.rst index 896beae78..2c5e8311a 100644 --- a/documentation/src/api_architecture.rst +++ b/documentation/src/api_architecture.rst @@ -8,7 +8,7 @@ User Interfaces User interfaces allow users to render the different generators. They handle the parameters of Generators and convert them to a readable -form. The user interfaces are located in `scripts/`. Currently there is +form. The user interfaces are located in :code:`scripts/`. Currently there is * scripts/boxes -- the command line interface * scripts/boxesserver -- the web interface diff --git a/documentation/src/index.rst b/documentation/src/index.rst index 4a6152e25..88e65f8e5 100644 --- a/documentation/src/index.rst +++ b/documentation/src/index.rst @@ -1,7 +1,5 @@ .. boxes.py documentation master file, created by sphinx-quickstart on Sun Mar 27 12:04:59 2016. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. Boxes.py ======== diff --git a/documentation/src/install.rst b/documentation/src/install.rst index fe22489b3..fa7d4fa86 100644 --- a/documentation/src/install.rst +++ b/documentation/src/install.rst @@ -44,7 +44,7 @@ in the :code:`boxes.formats.Formats` class. Python ...... -Boxes.py is implemented in Python 3. For supported minor version see `setup.py`. +Boxes.py is implemented in Python 3. For supported minor version see :code:`setup.py`. Sphinx ......