Updated development-notes.md

Author: Nusiq

development-notes.md

@@ -1,7 +1,6 @@
 # Tests
 Currently most of the code is not tested. The project has a basic `tox` setup
-which performs simple tests using `pytest` and generates documentation using 
-`sphinx`. The tests are far from complete.
+which performs simple tests using `pytest`.
 
 Use `tox` command to run the tests:
 ```
@@ -11,25 +10,21 @@ tox
 ## Configuration files explained
 - `setup.cfg` is a configuration for setuptools.
 - `tox.ini` defines what does the `tox` command do.
-- sphinx configuration is inside `sphinx_config/conf.py` file.
-- `sphinx_config/index.rst` defines the content of `index.html` file generated
-  with sphinx. There are other `rst` files that define other pages.
-- sphinx documentation is generated into `documentation/` path which is
-  excluded with `.gitignore`
+- sphinx configuration is inside `docs/conf.py` file.
+- sphinx documentation can be build using bat script inside `docs` folder.
+  In order to build the documentation for local preview `cd` into `docs` folder
+  and run `build.bat html` script. The documentation will be available in
+  `docs/_build/html` folder.
 - All test functions should have name compliant to these patterns: `test_*` or
   `*_test` (it's required by `pytest`).
 
 # Publishing documentation
-This code uses Github pages for documentation. The github pages code is
-a copy of `documentation/` directory moved to `gh-pages` branch.
+The projects is set up to publish documentation on readthedocs.org.
+This is very basic setup based on the tutorial:
+https://docs.readthedocs.io/en/stable/tutorial/
 
-You can use the `mv_documentation.py` script to copy content of the
-`documentation/` folder (generated with `tox`) to `gh-pages` branch in order
-to publish it.
-
-The script checkouts to the `gh-pages` branch, removes all fiels
-and moves the content of `documentation/` directory to root directory. If you
-want to stage and commit that changes you have to do that manually.
+The documentation is build automatically on every commit to the `master`
+branch.
 
 # Submodules
 The project uses a git submodule for the source code. I intend to use the same
@@ -44,6 +39,19 @@ git submodule foreach "git add -A"
 git submodule foreach "git commit -m 'Some comment.'"
 ```
 
+Pulling changes for submodules:
+```
+git submodule update --remote --recursive
+```
+
+After pulling, if you want to checkout the latest commit from the submodule
+you can use:
+```
+git submodule foreach "git checkout master"
+```
+(by default it checks out to specific commit)
+
+
 # Project configuration
 As of the writing of this document `setuptools` uses `setup.cfg` and the
 `pyproject.toml` is in beta. I expect that in the future everything will be