Skip to content

Commit 769fa63

Browse files
committed
update docs
1 parent d9bb63b commit 769fa63

File tree

6 files changed

+31
-43
lines changed

6 files changed

+31
-43
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ demo/dist/
55
demo/.embark/development/
66
demo/config/production/password
77
boilerplate/dist/
8-
docs/build
8+
docs/_build
99
docs/utils/__pycache_

docs/Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
77
SPHINXPROJ = embark
8-
SOURCEDIR = source
9-
BUILDDIR = build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
1010

1111
# Put it first so that "make" without argument is like "make help".
1212
help:

docs/source/conf.py renamed to docs/conf.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# -*- coding: utf-8 -*-
33
#
44
# embark documentation build configuration file, created by
5-
# sphinx-quickstart on Tue Jan 10 05:57:43 2017.
5+
# sphinx-quickstart on Tue Jan 10 06:39:27 2017.
66
#
77
# This file is execfile()d with the current directory set to its
88
# containing dir.
@@ -34,7 +34,7 @@
3434
extensions = []
3535

3636
# Add any paths that contain templates here, relative to this directory.
37-
templates_path = ['ntemplates']
37+
templates_path = ['_templates']
3838

3939
# The suffix(es) of source filenames.
4040
# You can specify multiple suffix as a list of string:
@@ -69,7 +69,7 @@
6969
# List of patterns, relative to source directory, that match files and
7070
# directories to ignore when looking for source files.
7171
# This patterns also effect to html_static_path and html_extra_path
72-
exclude_patterns = []
72+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
7373

7474
# The name of the Pygments (syntax highlighting) style to use.
7575
pygments_style = 'sphinx'
@@ -94,7 +94,7 @@
9494
# Add any paths that contain custom static files (such as style sheets) here,
9595
# relative to this directory. They are copied after the builtin static files,
9696
# so a file named "default.css" will overwrite the builtin "default.css".
97-
html_static_path = ['nstatic']
97+
html_static_path = ['_static']
9898

9999

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

docs/index.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. embark documentation master file, created by
2+
sphinx-quickstart on Tue Jan 10 06:39:27 2017.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to embark's documentation!
7+
==================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
14+
15+
Indices and tables
16+
==================
17+
18+
* :ref:`genindex`
19+
* :ref:`modindex`
20+
* :ref:`search`
21+
22+
Hello World!

docs/make.bat

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ REM Command file for Sphinx documentation
77
if "%SPHINXBUILD%" == "" (
88
set SPHINXBUILD=sphinx-build
99
)
10-
set SOURCEDIR=source
11-
set BUILDDIR=build
10+
set SOURCEDIR=.
11+
set BUILDDIR=_build
1212
set SPHINXPROJ=embark
1313

1414
if "%1" == "" goto help

docs/source/index.rst

Lines changed: 0 additions & 34 deletions
This file was deleted.

0 commit comments

Comments
 (0)