Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
ramijarrar committed Jun 7, 2017
1 parent fa091fd commit 8b48206
Show file tree
Hide file tree
Showing 13 changed files with 139 additions and 0 deletions.
1 change: 1 addition & 0 deletions documentation/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_build
20 changes: 20 additions & 0 deletions documentation/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = python -msphinx
SPHINXPROJ = MeteorAzure
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
2 changes: 2 additions & 0 deletions documentation/auto-login.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Automatic login
=================
2 changes: 2 additions & 0 deletions documentation/cli.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Command line options
=================
34 changes: 34 additions & 0 deletions documentation/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# -*- coding: utf-8 -*-

import sphinx_rtd_theme

# -------------------------------
# General
# -------------------------------

extensions = []
source_suffix = '.rst'
master_doc = 'index'
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# -------------------------------
# Project
# -------------------------------

project = u'Meteor Azure'
copyright = u'2017, Talos Technology Pty Ltd'
version = u'2.0.0-rc.4'
release = u'2.0.0-rc.4'

# -------------------------------
# Internationalization
# -------------------------------

language = 'en'

# -------------------------------
# Output
# -------------------------------

html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
2 changes: 2 additions & 0 deletions documentation/further-reading.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Further reading
=================
2 changes: 2 additions & 0 deletions documentation/getting-started.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Getting started
=================
2 changes: 2 additions & 0 deletions documentation/https-redirect.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
HTTPS redirect
=================
32 changes: 32 additions & 0 deletions documentation/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
Welcome to Meteor Azure's documentation!
========================================

Meteor Azure is a command line tool for deploying Meteor applications on Azure App Service.

The code is open source, and `available on GitHub`_.

.. _available on GitHub: https://github.com/fractal-code/meteor-azure

.. toctree::
:caption: Introduction

installation
getting-started
cli

.. toctree::
:caption: Configuration

settings-file
https-redirect
auto-login
multi-core

.. toctree::
:caption: Advanced

further-reading
.. Custom web config
Kudu interface
Troubleshooting
Further reading
2 changes: 2 additions & 0 deletions documentation/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Installation
=================
36 changes: 36 additions & 0 deletions documentation/make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=python -msphinx
)
set SOURCEDIR=.
set BUILDDIR=_build
set SPHINXPROJ=MeteorAzure

if "%1" == "" goto help

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The Sphinx module was not found. Make sure you have Sphinx installed,
echo.then set the SPHINXBUILD environment variable to point to the full
echo.path of the 'sphinx-build' executable. Alternatively you may add the
echo.Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%

:end
popd
2 changes: 2 additions & 0 deletions documentation/multi-core.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Multi core support
=================
2 changes: 2 additions & 0 deletions documentation/settings-file.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Settings file
=================

0 comments on commit 8b48206

Please sign in to comment.