Skip to content

Commit c448e4f

Browse files
author
Thibault BRONCHAIN
committed
add doc
1 parent bd926ad commit c448e4f

File tree

5 files changed

+854
-30
lines changed

5 files changed

+854
-30
lines changed

Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,15 @@ page:
5656

5757
commit:
5858
-git add -A
59-
-git ca --no-edit -m "Robot: Auto Deploy"
59+
-git commit -a --no-edit -m "Robot: Auto Deploy"
6060

6161
autocommit:
6262
-git add -A
63-
-git ca --no-edit -m "Robot: Auto Deploy"
63+
-git commit -a --no-edit -m "Robot: Auto Deploy"
6464

6565
deploy: page autocommit
6666
git push origin gh-pages
67-
git co master
67+
git checkout master
6868
@echo
6969
@echo "==========================================================="
7070
@echo " GitHub Pages has been Deployed!!!"

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
MadeiraCloud HTML5 IDE Documents
1+
MadeiraCloud Pysa Documents
22
========
33
## Edit
44
Our document is writed by Markdown so you can edit it by Mou or anyother Markdown Editor.
55
#### Document File
6-
`source/h5_doc.md`
6+
`source/index.md`
77
#### Attatch Image
8-
Put image in source folder or upload it to Amazon S3
8+
Put image in source/img folder or upload it to Amazon S3
99
#### Put it Online
1010
When you accomplish your edit work you must Build and Deploy it to make it effect
1111

@@ -22,16 +22,13 @@ Just run `make` command in project root folder. Then the document will build to
2222

2323

2424
## Deploy
25-
Run `make deploy` to deploy project on [GitHubPage](http://madeiracloud.github.io/h5-docs/) and [ReadTheDocs](http://madeiracloud-document.readthedocs.org/en/latest/)
25+
Run `make deploy` to deploy project on [ReadTheDocs](http://madeira-cloud-pysa-document.readthedocs.org/en/latest/)
2626

2727
## Changelog
2828

29-
- 2013-09-29 First Release.
29+
- 2013-10-15 First Release.
3030

3131
## Links
3232

33-
- [MadeiraCloud HTML5 IDE](https://ide.madeiracloud.com/v2/)
34-
35-
- [Document on GitHub Page](http://madeiracloud.github.io/h5-docs/)
36-
37-
- [Document on ReadtheDocs](http://madeiracloud-document.readthedocs.org/en/latest/)
33+
- [Pysa Project Page](http://madeiracloud.github.io/pysa/)
34+
- [Document on ReadtheDocs](http://madeira-cloud-pysa-document.readthedocs.org/en/latest/)

conf.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,17 @@
4343
master_doc = 'default'
4444

4545
# General information about the project.
46-
project = u'MadeiraCloud Document'
46+
project = u'Pysa'
4747
copyright = u'2013, MadeiraCloud'
4848

4949
# The version info for the project you're documenting, acts as replacement for
5050
# |version| and |release|, also used in various other places throughout the
5151
# built documents.
5252
#
5353
# The short X.Y version.
54-
version = '1.0.0'
54+
version = '0.2'
5555
# The full version, including alpha/beta/rc tags.
56-
release = '1.0.0'
56+
release = '0.2.6a'
5757

5858
# The language for content autogenerated by Sphinx. Refer to documentation
5959
# for a list of supported languages.
@@ -176,7 +176,7 @@
176176
#html_file_suffix = None
177177

178178
# Output file base name for HTML help builder.
179-
htmlhelp_basename = 'MadeiraCloudDocument'
179+
htmlhelp_basename = 'Pysa'
180180

181181

182182
# -- Options for LaTeX output ---------------------------------------------
@@ -196,8 +196,8 @@
196196
# (source start file, target name, title,
197197
# author, documentclass [howto/manual]).
198198
latex_documents = [
199-
('default', 'MadeiraCloudDocument.tex', u'MadeiraCloud Document',
200-
u'MadeiraCloud', 'manual'),
199+
('default', 'Pysa.tex', u'Pysa',
200+
u'Thibault BRONCHAIN, MadeiraCloud', 'manual'),
201201
]
202202

203203
# The name of an image file (relative to this directory) to place at the top of
@@ -226,8 +226,8 @@
226226
# One entry per manual page. List of tuples
227227
# (source start file, name, description, authors, manual section).
228228
man_pages = [
229-
('', 'MadeiraCloud Document', u'Documentation',
230-
[u'MadeiraCloud'], 1)
229+
('', 'Pysa', u'Documentation',
230+
[u'Thibault BRONCHAIN, MadeiraCloud'], 1)
231231
]
232232

233233
# If true, show URL addresses after external links.
@@ -240,8 +240,8 @@
240240
# (source start file, target name, title, author,
241241
# dir menu entry, description, category)
242242
texinfo_documents = [
243-
('', 'MadeiraCloud Document', u'Documentation',
244-
u'MadeiraCloud', 't', 'One line description of project.',
243+
('', 'Pysa', u'Documentation',
244+
u'Thibault BRONCHAIN, MadeiraCloud', 't', 'Pysa - Reverse your Servers Configuration',
245245
'Miscellaneous'),
246246
]
247247

0 commit comments

Comments
 (0)