patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

docs: fixed errors when building docs

Browse source 
Change-Id: If92be02af08ac8924a95fe1b1a2450ec1efab7da
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2016-02-21 08:06:48 -05:00 committed by Gerrit Code Review
parent c582d78cb2
commit ee55374d3c
3 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/Makefile
View file

@ -103,9 +103,9 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/forto-collab.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/zephyr.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/forto-collab.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/zephyr.qhc"
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@ -120,8 +120,8 @@ devhelp:
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/forto-collab"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/forto-collab"
@echo "# mkdir -p $$HOME/.local/share/devhelp/zephyr"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/zephyr"
@echo "# devhelp"
epub:

2
doc/collaboration/code/gerrit_practices.rst
View file

@ -411,7 +411,7 @@ The command above avoids the insertion of an unnecessary line before the Author
line.
To make these configuration changes specifically for the current Git user,
you must add the path option :option:`–-global` to :command:`config` as follows:
you must add the path option :option:`--global` to :command:`config` as follows:
.. code-block:: console

6
doc/collaboration/documentation/basic.rst
View file

@ -1,4 +1,5 @@
.. _basic:
Basic Writing Style Guidelines
##############################
@ -59,8 +60,7 @@ commit message or note. You can find more details of the concepts listed here in
* Do abbreviate codenames by using a substitution. For example:
\|codename\| is defined in the
:file:`forto-collab/doc/substitutions.rst` to be replaced by "Zephyr
Operating System".
:file:`ZEPHYR_BASE/doc/substitutions.rst` to be replaced by "Zephyr Kernel".
* Place figures and tables immediately after related text.
@ -71,4 +71,4 @@ commit message or note. You can find more details of the concepts listed here in
or below" whenever possible.
* Avoid inserting any table or figure without having at least one
direct cross-reference to it in the body text.
direct cross-reference to it in the body text.