Merge pull request #377 from diraol/release-2017.1b3

Updating version information for release.

Author: beraldoleal

AUTHORS.rst

@@ -6,6 +6,7 @@ Authors
 - Beraldo Leal <beraldo AT ncc DOT unesp DOT br>
 - Carlos Eduardo Moreira dos Santos <cadu AT ncc DOT unesp DOT br>
 - Diego Rabatone Oliveira <diraol AT ncc DOT unesp DOT br>
+- Erick Vermot <erick.vermot AT gmail DOT com>
 - Macártur de Sousa Carvalho <macartur.sc AT gmail DOT com>
 - Raphael Cobe <rmcobe AT ncc DOT unesp DOT br>
 - Renan Rodrigo <renanrb AT ime DOT usp DOT br>

CHANGELOG.rst

@@ -24,7 +24,7 @@ Security
 ========
 
 
-[2017.1b3] - "bethania" beta3 - 2017-06-14
+[2017.1b3] - "bethania" beta3 - 2017-06-16
 ******************************************
 Added
 =====
@@ -33,10 +33,12 @@ Added
 Changed
 =======
 - Raise ValueError if not using bytes (e.g. string) in BinaryData.
+- Changed docs to show a dropdown button with all python-openflow releases.
 
 Fixed
 =====
 - [v0x01] Fixed method to unpack error messages.
+- documentation: fixed links and build warnings.
 - A few bug fixes.
 
 

docs/.gitignore

@@ -1,3 +1,2 @@
 _rebuild
-modules.rst
 python.inv

docs/Makefile

@@ -2,10 +2,12 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    =
+SPHINXOPTS    = -W
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = _build
+VERSIONS      = master,bethania
+MAIN_REF      = bethania
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
@@ -53,6 +55,17 @@ help:
 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 	@echo "  coverage   to run coverage check of the documentation (if enabled)"
 	@echo "  dummy      to check syntax errors of document sources"
+	@echo "  versions   to make all docs HTML files"
+
+.PHONY: versions
+versions:
+	rm python-openflow -rf && mkdir python-openflow
+	for version in `echo $(VERSIONS) | sed 's/,/ /g'`; do \
+		git checkout $$version \
+		&& make SPHINXOPTS="-A versions=\"$(VERSIONS)\" -A current_version=\"$$version\"" \
+		&& mv _build/dirhtml python-openflow/$$version; \
+	done
+	cp python-openflow/$(MAIN_REF)/* python-openflow/ -R
 
 .PHONY: clean
 clean:
@@ -61,7 +74,7 @@ clean:
 
 .PHONY: html
 html:
-	sphinx-apidoc -o . ../pyof/ -d10 -M
+	sphinx-apidoc -o . ../pyof/ -d10 -M -T
 	sed -i "/Submodules/,+1d" *.rst
 	sed -i "/Subpackages/,+1d" *.rst
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@@ -70,7 +83,7 @@ html:
 
 .PHONY: dirhtml
 dirhtml:
-	sphinx-apidoc -o . ../pyof/ -d10 -M
+	sphinx-apidoc -o . ../pyof/ -d10 -M -T
 	sed -i "/Submodules/,+1d" *.rst
 	sed -i "/Subpackages/,+1d" *.rst
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@@ -242,7 +255,7 @@ dummy:
 	@echo "Build finished. Dummy builder generates no files."
 
 livehtml:
-	sphinx-apidoc -o . ../pyof/ -d10 -M
+	sphinx-apidoc -o . ../pyof/ -d10 -M -T
 	sed -i "/Submodules/,+1d" *.rst
 	sed -i "/Subpackages/,+1d" *.rst
 	sphinx-autobuild -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml -z ../pyof

docs/_static/css/kytos.css

@@ -16,6 +16,13 @@
   background: #68286a;
 }
 
+.navbar-kytos #dropdown-versions {
+  background-color: #322c5d;
+  border-color: #4D4778;
+  margin-top: 3%;
+  margin-left: 4%;
+}
+
 .navbar-kytos .navbar-brand {
   -webkit-transition: all .3s;
   -moz-transition: all .3s;

docs/_templates/navbar.html

@@ -18,6 +18,18 @@
     </div>
 
       <div class="collapse navbar-collapse nav-collapse">
+        {% if versions %}
+          <div class="dropdown pull-right">
+            <button id="dropdown-versions" class="btn btn-primary dropdown-toggle" type="button" data-toggle="dropdown"> {{ current_version }}
+            <span class="caret"></span></button>
+            <ul class="dropdown-menu">
+              {%- for version in versions.split(',') %}
+                <li><a href="/python-openflow/{{version}}">{{ version }}</a></li>
+              {%- endfor %}
+            </ul>
+          </div>
+        {% endif %}
+
         {% block navbarsearch %}
           {% include "navbarsearchbox.html" %}
         {% endblock %}

docs/conf.py

@@ -67,7 +67,7 @@
 version = u'2017.1'
 show_version = False
 # The full version, including alpha/beta/rc tags.
-release = u'2017.1b2'
+release = u'2017.1b3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -111,6 +111,9 @@
 # If true, keep warnings as "system message" paragraphs in the built documents.
 #keep_warnings = False
 
+# Remove nonlocal_uri warnings
+suppress_warnings = ['image.nonlocal_uri']
+
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
@@ -370,14 +373,8 @@
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
 
-# Example configuration for intersphinx: refer to the Python standard library.
-# Note: links to Python doc only work if you are online or have python.inv
-#     file. To download it, run:
-#     curl https://docs.python.org/3/objects.inv >python.inv
-intersphinx_mapping = {'python': ('https://docs.python.org/3',
-                                  (None, 'python.inv')),
-                       'kytos': ('http://docs.kytos.io/kytos',
-                                 (None, 'kytos.inv'))}
+intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
+                       'kytos': ('http://docs.kytos.io/kytos', None)}
 
 # Napoleon settings from http://www.sphinx-doc.org/en/stable/ext/napoleon.html
 napoleon_google_docstring = True

docs/get_involved.rst

@@ -5,5 +5,5 @@ We'd love for you to contribute to our source code and to make Kytos better
 than it is today!
 
 This is one component of the *Kytos* project. For more information on how to get
-involved, please, visit the section :doc:`kytos:get_involved` of the *Kytos*
+involved, please, visit the section :doc:`kytos:contributing` of the *Kytos*
 documentation.

docs/hacking.rst

@@ -2,7 +2,7 @@
 Hacking
 #######
 
-.. note:: Before reading this file, please read the :doc:`guidelines` section
+.. note:: Before reading this file, please read the :doc:`kytos:contributing` section
     that contains the main guidelines of the project.
 
 Development Environment Setup

docs/toc/introduction.rst

@@ -1,3 +1,5 @@
+:orphan:
+
 ############
 Introduction
 ############