Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions docs/source/folders.rst
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
Folder structure
================
Let’s start by showcasing the folder structure that we should aim for. Here is the folder structure of an example project, named ``simpleble`` (See `GitHub <https://github.com/sglvladi/simpleble>`_ repo and `ReadTheDocs <http://simpleble.readthedocs.io/en/latest/index.html>`_ documentation), which is also the package which we will base our tutorial on:
Here is the folder structure of an example project built with RTD, named ``simpleble`` (See `GitHub <https://github.com/sglvladi/simpleble>`_ repo and `ReadTheDocs <http://simpleble.readthedocs.io/en/latest/index.html>`_ documentation), which is also the package which we will base our tutorial on:

| simpleble-master
| ├── docs
| │ ├── build
| │ ├── make.bat
| simpleble-master/
| ├── docs/
| │ ├── build/
| │ ├── source/
| │ ├── Makefile
| │ └── source
| │ └── make.bat
| ├── simpleble/
| │ └── simpleble.py
| ├── LICENSE
| ├── README.md
| ├── requirements.txt
| └── simpleble
| └── simpleble.py
| └── requirements.txt
|
|

In the folder structure above:

- ``simpleble-master`` is the folder we get when we issue a ``git pull/clone`` command
- ``simpleble-master/docs`` is the directory where our Sphinx documentation will reside
- ``simpleble-master/docs/build`` and ``simpleble-master/docs/source`` being the Sphinx build and source directories respectively. These folders are autogenerated for us by Sphinx.
- ``simpleble-master/simpleble`` is the actual Python package directory, where our Python source files reside.
- ``simpleble-master`` is the repository root dir we get after a ``git pull/clone`` command
- ``simpleble-master/docs`` is where our Sphinx documentation will reside
- ``simpleble-master/docs/build`` and ``simpleble-master/docs/source`` are documentation build and source directories respectively. These folders are autogenerated by Sphinx.
- ``simpleble-master/simpleble`` is the directory with Python source files.

An important note here is that the folder ``simpleble-master`` is what we will refer to as our `Repository root`, while the folder ``simpleble-master/docs`` will be our `Sphinx root` or, equivalently, our `Documentation root`. Similarly, ``simpleble-master/docs/source`` will be our `Sphinx source root` and ``simpleble-master/docs/build`` is our `Sphinx build root`.
Note that we refer to ``simpleble-master`` as `Repository root`, and the folder ``simpleble-master/docs`` is our `Sphinx root` or, equivalently, our `Documentation root`. Similarly, ``simpleble-master/docs/source`` is our `Sphinx source root` and ``simpleble-master/docs/build`` is `Sphinx build root`.