Merge pull request #778 from macartur/fix_developer_doc

Fix kytos path and display a message that empty section will be updated soon

docs/Makefile

@@ -75,13 +75,13 @@ versions:
 
 .PHONY: clean
 clean:
-	rm -rf kytos.*
+	rm -rf ./developer/kytos_api/*
 	rm -rf $(BUILDDIR)/*
 
 .PHONY: html
 html:
 	$(PYTHON) home/make_home.py
-	sphinx-apidoc -o . ../kytos/ -d10 -M -T
+	sphinx-apidoc -o ./developer/kytos_api ../kytos/ -d10 -M -T
 	sed -i "/Submodules/,+1d" *.rst
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
@@ -90,7 +90,7 @@ html:
 .PHONY: dirhtml
 dirhtml:
 	$(PYTHON) home/make_home.py
-	sphinx-apidoc -o . ../kytos/ -d10 -M -T
+	sphinx-apidoc -o ./developer/kytos_api ../kytos/ -d10 -M -T
 	sed -i "/Submodules/,+1d" *.rst
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 	@echo
@@ -284,9 +284,10 @@ dummy:
 	@echo
 	@echo "Build finished. Dummy builder generates no files."
 
+.PHONY: livehtml
 livehtml:
 	$(PYTHON) home/make_home.py
-	sphinx-apidoc -o . ../kytos/ -d10 -M -T
+	sphinx-apidoc -o ./developer/kytos_api ../kytos/ -d10 -M -T
 	sed -i "/Submodules/,+1d" *.rst
 	sphinx-autobuild --re-ignore "\.[^.]+" -r ".+~" -b dirhtml \
 	    $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml -z ../kytos

docs/admin/index.rst

@@ -71,4 +71,3 @@ Kytos Summit is the main Kytos Project’s event. In addition to afull schedule
   web-ui
   upgrade_kytos
   uninstall_kytos
-  monitoring_kytos

docs/developer/how_to_create_tests.rst

@@ -1,3 +1,5 @@
 *******************
 How to create tests
 *******************
+
+.. note:: This section will be updated soon.

docs/developer/index.rst

@@ -84,7 +84,7 @@ Kytos Summit provides an opportunity for developers, contributors and other inte
    intro
    architecture
    setup_develop_environment
-   Kytos API <../kytos>
+   Kytos API <./kytos_api/kytos>
    creating_a_napp
    how_to_create_tests
    how_to_contribute

docs/developer/intro.rst

@@ -1,3 +1,21 @@
 ************
 Introduction
 ************
+
+This guide is intended to guide you in how to setup and
+develop new features inside the Kytos Project. Please, before proceeding
+make sure that you have read the
+`Kytos introduction <https://docs.kytos.io/>` and
+`Admin Guide <http://docs.kytos.io/https://docs.kytos.io/admin/index.html>`.
+
+In this section you will learn about:
+
+- :doc:`Architecture Overview  </developer/architecture>`
+- :doc:`Preparing your Development Environment </developer/setup_develop_environment/>`
+- :doc:`Kytos API </developer/kytos_api/kytos>`
+- :doc:`How to develop your NApp </developer/creating_a_napp/>`
+- :doc:`How to create Tests </developer/creating_a_napp/>`
+- :doc:`How to Contribute </developer/how_to_create_tests/>`
+- :doc:`Hacking </developer/hacking/>`
+- :doc:`Security </developer/security/>`
+- :doc:`Python Openflow </developer/pyof/>`

docs/developer/security.rst

@@ -1,3 +1,5 @@
 ********
 Security
 ********
+
+.. note:: This section will be updated soon.

kytos/core/helpers.py

@@ -26,7 +26,7 @@ def listen_to(event, *events):
 
     The event that will be listened to is always a string, but it can represent
     a regular expression to match against multiple Event Types. All listened
-    events are documented in :doc:`developer/listened_events` section.
+    events are documented in :doc:`/developer/listened_events` section.
 
     Example of usage: