Commit 13ce2d62 authored by Anas Nashif's avatar Anas Nashif Committed by Anas Nashif
Browse files

doc: show information about documentation current version 



show different information based on the state of the current
documentation and link to development version and released
versions depending on where the user lands.

Change-Id: Ifa6263900222db483efa0388e2588dd97222ecb6
Signed-off-by: default avatarAnas Nashif <anas.nashif@intel.com>
parent 828fe15b

doc/Makefile

+2 −1
Original line number Diff line number Diff line
@@ -6,6 +6,7 @@ SPHINXOPTS = 
SPHINXBUILD   = sphinx-build

PAPER         =

BUILDDIR      = _build

DOC_TAG      ?= development



# User-friendly check for sphinx-build

ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
@@ -66,7 +67,7 @@ kconfig: scripts/genrest/genrest.py 
	srctree=../ SRCARCH=x86 python $< ../Kconfig reference/kconfig/



html: kconfig

	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

	$(SPHINXBUILD) -t $(DOC_TAG) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

	@mkdir -p $(BUILDDIR)/html/api

	@cp -a html $(BUILDDIR)/html/api

	@echo

doc/index.rst

+19 −1
Original line number Diff line number Diff line
@@ -4,8 +4,24 @@ 
Zephyr Project Documentation

############################



.. only:: release



   Welcome to the Zephyr Project's documentation version |version|!



   Documentation for the development branch of Zephyr can be found at

   https://www.zephyrproject.org/doc/dev/



.. only:: development



   Welcome to the Zephyr Project's documentation. This is the documentation of the

   master tree under development.



   Documentation for released versions of Zephyr can be found at

   ``https://www.zephyrproject.org/doc/<version>``, for example:



   * Documentation for `Zephyr 1.2.0`_

   * Documentation for `Zephyr 1.1.0`_



Sections

********
@@ -34,3 +50,5 @@ Indices and Tables 
* :ref:`search`



.. _Zephyr Project Wiki: https://wiki.zephyrproject.org/view/Main_Page

.. _Zephyr 1.2.0: https://www.zephyrproject.org/doc/1.2.0/

.. _Zephyr 1.1.0: https://www.zephyrproject.org/doc/1.1.0/

CRA Git | Maintained and supported by SUSTech CRA and CCSE