mynewt-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] aditihilbert closed pull request #127: docs: a previewer
Date Thu, 01 Jan 1970 00:00:00 GMT
aditihilbert closed pull request #127: docs: a previewer
URL: https://github.com/apache/mynewt-newt/pull/127
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 00000000..2abe8a03
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1,5 @@
+xml
+node_modules
+_build
+doxygen_*
+*.pyc
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 00000000..da8a7b36
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,16 @@
+# Make a preview site for Sphinx output
+
+BUILDDIR      = _build/html
+
+.PHONY: Makefile clean preview
+
+clean:
+	rm -rf _build
+
+preview: _build sphinx
+
+_build:
+	mkdir -p _build
+
+sphinx:
+	sphinx-build . ${BUILDDIR}
diff --git a/docs/README.rst b/docs/README.rst
new file mode 100644
index 00000000..032ff328
--- /dev/null
+++ b/docs/README.rst
@@ -0,0 +1,29 @@
+Mynewt Newt Tool Documentation
+#################################
+
+This folder holds the documentation for the newt tool for the
+`Apache Mynewt`_ project. It is  built using `Sphinx`_.
+
+The complete project documentation can be found at `mynewt documentation`_
+
+.. contents::
+
+Writing Documentation
+=======================
+
+See: https://github.com/apache/mynewt-documentation#writing-documentation
+
+Previewing Changes
+==========================
+
+In order to preview any changes you make you must first install a Sphinx toolchain as
+described at https://github.com/apache/mynewt-documentation#id3. Then:
+
+.. code-block:: bash
+
+  $ cd docs
+  $ make clean && make preview && (cd _build/html && python -m SimpleHTTPServer
8080)
+
+.. _Apache Mynewt: https://mynewt.apache.org/
+.. _mynewt documentation: https://github.com/apache/mynewt-documentation
+.. _Sphinx: http://www.sphinx-doc.org/
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 00000000..42d6e8bf
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,177 @@
+# -*- coding: utf-8 -*-
+#
+# Mynewt documentation build configuration file, created by
+# sphinx-quickstart on Tue Jan 10 11:33:44 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('_ext'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc', 'breathe', 'sphinx.ext.todo',
+    'sphinx.ext.extlinks'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = []
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Mynewt Newt Tool'
+copyright = u'Copyright ? 2017 The Apache Software Foundation, Licensed under the Apache
License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software
Foundation.'
+author = u'The Apache Software Foundation'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'1.0'
+# The full version, including alpha/beta/rc tags.
+release = u'1.0.0-b1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'README.rst', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+highlight_language = 'none'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+
+html_theme = 'alabaster'
+html_theme_path = []
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',
+        'searchbox.html',
+        'donate.html',
+    ]
+}
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+html_theme_options = {
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = []
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Mynewtdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'Mynewt.tex', u'Mynewt Newt Tool',
+     u'The Apache Software Foundation', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'mynewt', u'Mynewt Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'Mynewt', u'Mynewt Newt Tool',
+     author, 'Mynewt', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+breathe_projects = {
+    "mynewt": "_build/xml"
+}
+breathe_default_project = "mynewt"
+# breathe_domain_by_extension = {
+#     "h" : "c",
+# }
diff --git a/docs/install/newt_mac.rst b/docs/install/newt_mac.rst
index 0c1333c0..f7b55666 100644
--- a/docs/install/newt_mac.rst
+++ b/docs/install/newt_mac.rst
@@ -12,7 +12,7 @@ This page shows you how to:
 See :doc:`prev_releases` to install an earlier version of newt.
 
 **Note:** If you would like to contribute to the newt tool, see :doc:`Setting Up Go Environment
to Contribute
-to Newt and Newtmgr Tools </misc/go_env>`.
+to Newt and Newtmgr Tools <../../misc/go_env>`.
 
 Installing Homebrew
 ~~~~~~~~~~~~~~~~~~~


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message