aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorchriseth <c@ethdev.com>2016-05-19 04:10:49 +0800
committerchriseth <c@ethdev.com>2016-05-19 04:10:49 +0800
commit8efd6dd27a9ae1ccb8391ac326f04dff55129b5f (patch)
tree0a8d165c49bc79762be8cefb6632535bad364f5b
parentec061b09a3a0093bada684d6109579b20d6775c5 (diff)
parent798775fa1b8ace8cc94efab822058c75f70670a4 (diff)
downloaddexon-solidity-8efd6dd27a9ae1ccb8391ac326f04dff55129b5f.tar
dexon-solidity-8efd6dd27a9ae1ccb8391ac326f04dff55129b5f.tar.gz
dexon-solidity-8efd6dd27a9ae1ccb8391ac326f04dff55129b5f.tar.bz2
dexon-solidity-8efd6dd27a9ae1ccb8391ac326f04dff55129b5f.tar.lz
dexon-solidity-8efd6dd27a9ae1ccb8391ac326f04dff55129b5f.tar.xz
dexon-solidity-8efd6dd27a9ae1ccb8391ac326f04dff55129b5f.tar.zst
dexon-solidity-8efd6dd27a9ae1ccb8391ac326f04dff55129b5f.zip
Merge pull request #582 from chriseth/travisForDocs
Use travis to check documentation.
-rw-r--r--.travis.yml11
-rw-r--r--docs/conf.py2
-rw-r--r--docs/layout-of-source-files.rst2
-rw-r--r--docs/types.rst2
4 files changed, 15 insertions, 2 deletions
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 00000000..07458841
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,11 @@
+# This is used to verify that the documentation compiles.
+language: python
+python:
+ - "2.7"
+# command to install dependencies
+install: "pip install -q Sphinx==1.1.3 --use-mirrors"
+# command to run tests
+script: cd docs && sphinx-build -nW -b html -d _build/doctrees . _build/html
+# Flags used here, not in `make html`:
+# -n Run in nit-picky mode. Currently, this generates warnings for all missing references.
+# -W Turn warnings into errors. This means that the build stops at the first warning and sphinx-build exits with exit status 1.
diff --git a/docs/conf.py b/docs/conf.py
index 48664344..8776ec43 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -134,7 +134,7 @@ html_theme = 'default'
# 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']
+html_static_path = []
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
diff --git a/docs/layout-of-source-files.rst b/docs/layout-of-source-files.rst
index 5b81b0e8..dcb18518 100644
--- a/docs/layout-of-source-files.rst
+++ b/docs/layout-of-source-files.rst
@@ -88,7 +88,7 @@ the following in your source file:
and then run the compiler as
-.. code-block:: shell
+.. code-block:: bash
solc github.com/ethereum/dapp-bin/=/usr/local/dapp-bin/ source.sol
diff --git a/docs/types.rst b/docs/types.rst
index 4beea9e0..93e70ddb 100644
--- a/docs/types.rst
+++ b/docs/types.rst
@@ -56,6 +56,8 @@ operators are :ref:`literals<integer_literals>` (or literal expressions).
.. index:: address, balance, send, call, callcode, delegatecall
+.. _address:
+
Address
-------