Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
nutanixdevteam committed May 12, 2020
0 parents commit 323a016
Show file tree
Hide file tree
Showing 24 changed files with 432 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.DS_Store
242 changes: 242 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,242 @@
# -*- coding: utf-8 -*-
#
# Nutanix Labs documentation build configuration file, created by
# sphinx-quickstart on Fri Oct 27 12:18:41 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
import sphinx_bootstrap_theme
import sphinx_fontawesome
#sys.path.insert(0, os.path.abspath('..'))


# -- 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.todo',
'sphinx.ext.ifconfig',
'sphinxcontrib.fulltoc',
'sphinx_fontawesome']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'Nutanix Tech Summit 2018'
copyright = u'2018 Nutanix'
author = u'Nutanix Global Technical Enablement'

# 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''
# The full version, including alpha/beta/rc tags.
release = u''

# 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', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True


# -- 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 = "sphinx_rtd_theme"
html_theme = 'bootstrap'
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()

# (Optional) Logo. Should be small enough to fit the navbar (ideally 24x24).
# Path should be relative to the ``_static`` files directory.
html_logo = "NutanixTechSummit.svg"

html_favicon = "favicon.ico"

html_title = ""

html_show_sphinx = False

#html_add_permalinks = ""

# 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 = {}
# Theme options are theme-specific and customize the look and feel of a
# theme further.
html_theme_options = {

}

html_theme_options = {
# Navigation bar title. (Default: ``project`` value)
'navbar_title': " ",

# Tab name for entire site. (Default: "Site")
'navbar_site_name': "",

# A list of tuples containing pages or urls to link to.
# Valid tuples should be in the following forms:
# (name, page) # a link to a page
# (name, "/aa/bb", 1) # a link to an arbitrary relative url
# (name, "http://example.com", True) # arbitrary absolute url
# Note the "1" or "True" value above as the third argument to indicate
# an arbitrary url.
#'navbar_links': [
# ("Examples", "examples"),
# ("Link", "http://example.com", True),
#],

# Render the next and previous page links in navbar. (Default: true)
'navbar_sidebarrel': False,

# Render the current pages TOC in the navbar. (Default: true)
'navbar_pagenav': False,

# Tab name for the current pages TOC. (Default: "Page")
'navbar_pagenav_name': "Page",

# Global TOC depth for "site" navbar tab. (Default: 1)
# Switching to -1 shows all levels.
'globaltoc_depth': 2,

# Include hidden TOCs in Site navbar?
#
# Note: If this is "false", you cannot have mixed ``:hidden:`` and
# non-hidden ``toctree`` directives in the same page, or else the build
# will break.
#
# Values: "true" (default) or "false"
'globaltoc_includehidden': "true",

# HTML navbar class (Default: "navbar") to attach to <div> element.
# For black navbar, do "navbar navbar-inverse"
'navbar_class': "navbar-inverse",

# Fix navigation bar to top of page?
# Values: "true" (default) or "false"
'navbar_fixed_top': "false",

# Location of link to source.
# Options are "nav" (default), "footer" or anything else to exclude.
'source_link_position': "footer",

# Bootswatch (http://bootswatch.com/) theme.
#
# Options are nothing (default) or the name of a valid theme
# such as "cosmo" or "sandstone".
#'bootswatch_theme': "united",

# Choose Bootstrap version.
# Values: "3" (default) or "2" (in quotes)
'bootstrap_version': "3",
}

html_sidebars = {'**': ['localtoc.html']}

# 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 = ['_static']

# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
#htmlhelp_basename = 'NutanixLabsdoc'


# -- 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, 'NutanixLabs.tex', u'Nutanix Labs Documentation',
u'Nutanix Global Technical Enablement', '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, 'nutanixlabs', u'Nutanix Labs 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, 'NutanixLabs', u'Nutanix Labs Documentation',
author, 'NutanixLabs', 'One line description of project.',
'Miscellaneous'),
]
Binary file added contents/images/add_aliases.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/images/add_providers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/images/code_sample_copy_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/images/composer_install_guzzle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/images/composer_update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/images/create_app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/images/linux_logo_32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/images/new_app_running.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/images/osx_logo_32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/images/public_structure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/images/publish_vendor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/images/request_completed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/images/styled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/images/ui_loaded.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/images/unstyled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added contents/images/windows_logo_32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions contents/intro.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Main Title
##########

Subtitle Level 1
................

Blah blah blah.

`This is a link to Nutanix.dev <https://www.nutanix.dev>`_.

Another Subtitle Level 1
.........................

Blah blah blah.

`This is a link to Nutanix.dev <https://www.nutanix.dev>`_.

.. note::

This is a note.

Subtitle Level 2
~~~~~~~~~~~~~~~~

Blah blah blah.

Here's some text.

**This text is bold.**

Summary for the Intro
.....................

Summary here.
62 changes: 62 additions & 0 deletions contents/master_follow.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
How to Follow this Lab
######################

Each lab is broken into sub-sections, one for each of the relevant topics.

Required Steps
--------------

When a section requires you to carry out specific ordered steps, each step will be bullet-pointed:

- Step 1
- Sub-task within step 1
- Step 2
- Step 3
- Sub-task within step 3

Additional Notes
----------------

A specific section's related details or important information will be shown as a highlighted note:

.. note::

This is a note, and should be read as accompanying information for the section or step above.

Code Samples
------------

Many sections and steps through the Nutanix Developer labs will be accompanied with code samples or code you should copy & paste, or add to a file. When a code block relates to a specific section or step, it will be included/indented as part of the section or step contents. An example is shown below.

- Step 1 has related code below:

.. code-block:: python
#!/usr/bin/env python
print('This code relates to step 1.')
print('Kthxbye!')
- Step 2 has no related code
- Step 3 has no related code

.. code-block:: python
#!/usr/bin/env python
print('This is a code block that does not belong to a specific step.')
print('Note the indentation i.e. this code is not indented under step 3.')
Copying Code Samples
--------------------

The code samples in the Nutanix Developer labs, as outlined above, are provided with a single-click copy button. Moving your mouse over any code sample will show a copy button at the top-right of the code sample window. A **screenshot** is shown below; note the copy button shown at the top-right of the code sample window:

.. figure:: images/code_sample_copy_button.png

Please make sure to use this button when copying code samples as it will ensure the code is copied to your clipboard without modification and in a format suitable for pasting into your editor.

Resources
---------

To aid in saving your progress throughout the lab, all internal and external links will open in a new browser tab or window.

Link example: `Nutanix Developer Portal <https://www.nutanix.dev>`_ (opens in a new window).
16 changes: 16 additions & 0 deletions contents/thoughts.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Final Thoughts
##############

Introduce your final thoughts here.

What was accomplished? What did your users create?

For further information on Nutanix Developer Resources, please see the `Nutanix Developer Portal <https://www.nutanix.dev>`_.

- `Code samples <https://www.nutanix.dev/code-samples>`_
- `Documentation <https://www.nutanix.dev/api-reference>`_
- `Labs <https://www.nutanix.dev/labs>`_

Thanks for attending this lab with us. We hope it was useful and informative.

Have a great day!
Loading

0 comments on commit 323a016

Please sign in to comment.