From ddaf4d335bc66098abdc021abb78e49f413ae02e Mon Sep 17 00:00:00 2001
From: acs-ws <asolak@ku.edu.tr>
Date: Tue, 11 Oct 2022 15:10:57 -0700
Subject: [PATCH 1/2] initial commit

---
 docs/source/devguides/devdocs.rst | 0
 docs/source/devguides/release.rst | 0
 docs/source/index.rst             | 8 ++++++++
 3 files changed, 8 insertions(+)
 create mode 100644 docs/source/devguides/devdocs.rst
 create mode 100644 docs/source/devguides/release.rst

diff --git a/docs/source/devguides/devdocs.rst b/docs/source/devguides/devdocs.rst
new file mode 100644
index 00000000..e69de29b
diff --git a/docs/source/devguides/release.rst b/docs/source/devguides/release.rst
new file mode 100644
index 00000000..e69de29b
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 5bd23ec0..c890f65a 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -136,3 +136,11 @@ If you find Aydin useful and use it in your work, please kindly consider to cite
 
    On Github <contact_us/github>
    On image.sc <contact_us/imagesc>
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+   :caption: Developer Guides
+
+   Building dev Docs <devguides/devdocs>
+   Making a Release <devguides/release>

From d615403b6ff343f47ab109bb5750b8e879cae21c Mon Sep 17 00:00:00 2001
From: acs-ws <asolak@ku.edu.tr>
Date: Tue, 11 Oct 2022 16:45:08 -0700
Subject: [PATCH 2/2] build dev docs is written

---
 docs/source/dev_guides/build_dev_docs.rst     | 56 +++++++++++++++++++
 .../{devguides => dev_guides}/release.rst     |  0
 docs/source/devguides/devdocs.rst             |  0
 docs/source/index.rst                         |  4 +-
 4 files changed, 58 insertions(+), 2 deletions(-)
 create mode 100644 docs/source/dev_guides/build_dev_docs.rst
 rename docs/source/{devguides => dev_guides}/release.rst (100%)
 delete mode 100644 docs/source/devguides/devdocs.rst

diff --git a/docs/source/dev_guides/build_dev_docs.rst b/docs/source/dev_guides/build_dev_docs.rst
new file mode 100644
index 00000000..935712e0
--- /dev/null
+++ b/docs/source/dev_guides/build_dev_docs.rst
@@ -0,0 +1,56 @@
+====================
+Build dev Docs
+====================
+
+Aydin documentation webpage(aydin.app) hosts documentation only for released versions.
+One can build the documentation on latest main branch commit or on a feature branch with
+the following steps:
+
+Install documentation dependencies
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can change to do `docs` folder and install documentation dependencies with
+the help of `requirements-docs.txt` file by following two lines.
+
+.. code-block:: bash
+
+   $ cd docs
+   $ pip install -r requirements-docs.txt
+
+
+Clean the docs/build folder and build the docs from scratch
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: bash
+
+   $ make clean
+   $ make html
+
+
+After execution of `make html` command, one can find the built docs in the `docs/build/html`
+folder. `index.html` in the mentioned folder will be the entry to point to the documentation.
+
+
+Build docs to publish
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: bash
+
+   $ make clean
+   $ make publish
+
+
+Our Makefile implements the `publish` command, to build documentation of all tagged versions
+at the current branch. You might wondering, do we have to build docs for all versions
+whenever we want to publish an update? Answer is yes. This is due to the nature of sphinx link
+injection architecture and if we don't build for all versions when we have a new version
+basically we will not have links for forward traverse between documentation versions.
+
+
+
+
+
+
+TODO: Add how to update deployed docs on GitHub Pages.
+
+
diff --git a/docs/source/devguides/release.rst b/docs/source/dev_guides/release.rst
similarity index 100%
rename from docs/source/devguides/release.rst
rename to docs/source/dev_guides/release.rst
diff --git a/docs/source/devguides/devdocs.rst b/docs/source/devguides/devdocs.rst
deleted file mode 100644
index e69de29b..00000000
diff --git a/docs/source/index.rst b/docs/source/index.rst
index c890f65a..e54d68be 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -142,5 +142,5 @@ If you find Aydin useful and use it in your work, please kindly consider to cite
    :hidden:
    :caption: Developer Guides
 
-   Building dev Docs <devguides/devdocs>
-   Making a Release <devguides/release>
+   Building dev Docs <dev_guides/build_dev_docs>
+   Making a Release <dev_guides/release>