[MediaWiki-commits] [Gerrit] Include README.rst in Sphinx generated doc - change (mediawiki...scap)

2015-04-06 Thread jenkins-bot (Code Review) 
jenkins-bot has submitted this change and it was merged.

Change subject: Include README.rst in Sphinx generated doc
..


Include README.rst in Sphinx generated doc

The ascii art pig landed in README.rst but was not shown in the Sphinx
generated documentation.

* Include README.rst from index.rst
* Move introduction sentence from index.rst to README.rst, the later is
  more likely to be read first.
* Fix footnotes references to please Sphinx

Change-Id: Ib781947b4a819f731b72ec8e4f35399970f467d3
---
M README.rst
M docs/index.rst
2 files changed, 12 insertions(+), 7 deletions(-)

Approvals:
  BryanDavis: Looks good to me, approved
  jenkins-bot: Verified



diff --git a/README.rst b/README.rst
index 2b2ebcf..fdd0e01 100644
--- a/README.rst
+++ b/README.rst
@@ -1,3 +1,5 @@
+::
+
___ 
  ⎛   ⎛ ,
   \  //==--'
@@ -10,14 +12,15 @@
 scap
 
 
-scap is the deployment script used by Wikimedia Foundation.
+**Scap** ("sync-common-all-php) is the deployment script used by Wikimedia
+Foundation to publish code and configuration on production web servers.
 
 
 credits
 ~~~
 
-Ascii art derived from original work by Joan Stark [#]_ and the `speed` figlet
-font [#]_.
+Ascii art derived from original work by Joan Stark [#pig]_ and the `speed`
+figlet font [#speedfont]_.
 
-... [#] http://www.geocities.com/spunk/farm.htm#pig
-... [#] http://www.jave.de/figlet/fonts/details/speed.html
+.. [#pig] http://www.geocities.com/spunk/farm.htm#pig
+.. [#speedfont] http://www.jave.de/figlet/fonts/details/speed.html
diff --git a/docs/index.rst b/docs/index.rst
index a0bee55..e4a7f25 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2,8 +2,10 @@
 Scap documentation
 ##
 
-**Scap** ("sync-common-all-php") is a collection of scripts used to publish 
code
-and configuration to the Wikimedia Foundation production web servers.
+.. include:: ../README.rst
+
+Content
+===
 
 .. toctree::
:maxdepth: 2

-- 
To view, visit https://gerrit.wikimedia.org/r/202240
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: Ib781947b4a819f731b72ec8e4f35399970f467d3
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/tools/scap
Gerrit-Branch: master
Gerrit-Owner: Hashar 
Gerrit-Reviewer: BryanDavis 
Gerrit-Reviewer: jenkins-bot <>

___
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

[MediaWiki-commits] [Gerrit] Include README.rst in Sphinx generated doc - change (mediawiki...scap)

2015-04-06 Thread Hashar (Code Review) 
Hashar has uploaded a new change for review.

  https://gerrit.wikimedia.org/r/202240

Change subject: Include README.rst in Sphinx generated doc
..

Include README.rst in Sphinx generated doc

The ascii art pig landed in README.rst but was not shown in the Sphinx
generated documentation.

* Include README.rst from index.rst
* Move introduction sentence from index.rst to README.rst, the later is
  more likely to be read first.
* Fix footnotes references to please Sphinx

Change-Id: Ib781947b4a819f731b72ec8e4f35399970f467d3
---
M README.rst
M docs/index.rst
2 files changed, 12 insertions(+), 7 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/mediawiki/tools/scap 
refs/changes/40/202240/1

diff --git a/README.rst b/README.rst
index 2b2ebcf..fdd0e01 100644
--- a/README.rst
+++ b/README.rst
@@ -1,3 +1,5 @@
+::
+
___ 
  ⎛   ⎛ ,
   \  //==--'
@@ -10,14 +12,15 @@
 scap
 
 
-scap is the deployment script used by Wikimedia Foundation.
+**Scap** ("sync-common-all-php) is the deployment script used by Wikimedia
+Foundation to publish code and configuration on production web servers.
 
 
 credits
 ~~~
 
-Ascii art derived from original work by Joan Stark [#]_ and the `speed` figlet
-font [#]_.
+Ascii art derived from original work by Joan Stark [#pig]_ and the `speed`
+figlet font [#speedfont]_.
 
-... [#] http://www.geocities.com/spunk/farm.htm#pig
-... [#] http://www.jave.de/figlet/fonts/details/speed.html
+.. [#pig] http://www.geocities.com/spunk/farm.htm#pig
+.. [#speedfont] http://www.jave.de/figlet/fonts/details/speed.html
diff --git a/docs/index.rst b/docs/index.rst
index a0bee55..e4a7f25 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2,8 +2,10 @@
 Scap documentation
 ##
 
-**Scap** ("sync-common-all-php") is a collection of scripts used to publish 
code
-and configuration to the Wikimedia Foundation production web servers.
+.. include:: ../README.rst
+
+Content
+===
 
 .. toctree::
:maxdepth: 2

-- 
To view, visit https://gerrit.wikimedia.org/r/202240
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: Ib781947b4a819f731b72ec8e4f35399970f467d3
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/tools/scap
Gerrit-Branch: master
Gerrit-Owner: Hashar 

___
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits