Skip to content

Commit

Permalink
Merge "[FAB-3630] enable RTD build process on fabric-ca"
Browse files Browse the repository at this point in the history
  • Loading branch information
mastersingh24 authored and Gerrit Code Review committed May 26, 2017
2 parents 7f61df1 + a5ab60d commit 9db5dcb
Show file tree
Hide file tree
Showing 10 changed files with 455 additions and 1 deletion.
20 changes: 20 additions & 0 deletions docs/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 = hyperledger-fabric-ca
SOURCEDIR = source
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)
36 changes: 36 additions & 0 deletions docs/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=source
set BUILDDIR=build
set SPHINXPROJ=hyperledger-fabric-ca

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
14 changes: 14 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
python-markdown-math==0.2

alabaster==0.7.8
Babel==2.3.4
docutils==0.12
imagesize==0.7.1
Jinja2==2.8
MarkupSafe==0.23
Pygments==2.1.3
pytz==2016.4
six==1.10.0
snowballstemmer==1.2.1
Sphinx==1.4.4
sphinx-rtd-theme==0.1.9
181 changes: 181 additions & 0 deletions docs/source/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
@import "theme.css";

/* Highlights */

.highlight .k,
.highlight .kd {
color: #263673;
}


/* Text */

body,
h1,
h2,
.rst-content .toctree-wrapper p.caption,
h3,
h4,
h5,
h6,
legend,
input {
color: #010101;
letter-spacing: 0.3px
}

p {
font-size: 100%; /* Get rid of RTD rule that assumes nobody changes their browser font size */
}


/* Links */

a {
color: #6ca158
}

a:hover {
color: #6ca158
}

a:visited {
color: #ADAFB3
}


/* Side navigation bar */

.wy-side-nav-search {
background-color: #252627;
}

.wy-side-nav-search a.icon-home {
color: transparent;
/* background-image: url('../images/fabric1.png'); */
background-repeat: no-repeat;
background-size: Auto 20px;
background-position: center top;
background-origin: content box;
height: 20px;
width: 100%
}

.wy-side-nav-search input[type=text] {
border-radius: 5px
}

.wy-menu-vertical a:hover {
background-color: #ADAFB3;
color: #FFF
}

.wy-nav-content {
background-color: #fff max-width: 1000px;
}

.wy-nav-side {
background-color: #252627;
}


/* Navigation headers */

.rst-content tt.literal,
.rst-content tt.literal,
.rst-content code.literal {
color: ##d43232;
text-transform: none;
}

.wy-menu-vertical header,
.wy-menu-vertical p.caption {
color: #6ca158;
}


/* Code snippets */

.codesnippet-widgets {
min-width: 100%;
display: block;
background: #005CAB;
color: white;
padding: 10px 0;
margin: 0 0 -1px 0;
}

.codesnippet-widgets > span {
padding: 10px;
cursor: pointer;
}

.codesnippet-widgets > .current {
background: #263673;
}

.codeset > .highlight-java {
display: none;
}


/* Notification boxes */

.wy-alert.wy-alert-warning .wy-alert-title,
.rst-content .wy-alert-warning.note .wy-alert-title,
.rst-content .attention .wy-alert-title,
.rst-content .caution .wy-alert-title,
.rst-content .wy-alert-warning.danger .wy-alert-title,
.rst-content .wy-alert-warning.error .wy-alert-title,
.rst-content .wy-alert-warning.hint .wy-alert-title,
.rst-content .wy-alert-warning.important .wy-alert-title,
.rst-content .wy-alert-warning.tip .wy-alert-title,
.rst-content .warning .wy-alert-title,
.rst-content .wy-alert-warning.seealso .wy-alert-title,
.rst-content .admonition-todo .wy-alert-title,
.wy-alert.wy-alert-warning .rst-content .admonition-title,
.rst-content .wy-alert.wy-alert-warning .admonition-title,
.rst-content .wy-alert-warning.note .admonition-title,
.rst-content .attention .admonition-title,
.rst-content .caution .admonition-title,
.rst-content .wy-alert-warning.danger .admonition-title,
.rst-content .wy-alert-warning.error .admonition-title,
.rst-content .wy-alert-warning.hint .admonition-title,
.rst-content .wy-alert-warning.important .admonition-title,
.rst-content .wy-alert-warning.tip .admonition-title,
.rst-content .warning .admonition-title,
.rst-content .wy-alert-warning.seealso .admonition-title,
.rst-content .admonition-todo .admonition-title {
background-color: #263673
}

.wy-alert,
.rst-content .note,
.rst-content .attention,
.rst-content .caution,
.rst-content .danger,
.rst-content .error,
.rst-content .hint,
.rst-content .important,
.rst-content .tip,
.rst-content .warning,
.rst-content .seealso,
.rst-content .admonition-todo {
background-color: #d9e5ef
}


/* Mobile view */

.wy-nav-top {
background-color: #252627;
}

.wy-nav-top a {
color: transparent;
/* background-image: url('../images/fabric1.png'); */
background-repeat: no-repeat;
background-size: Auto 19px;
background-position: center top;
background-origin: content box;
}
7 changes: 7 additions & 0 deletions docs/source/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{% extends "!layout.html" %}
{% block sidebartitle %}
{{ super() }}
<br>
<a href="https://chat.hyperledger.org">Rocket Chat</a> <a href="https://jenkins.hyperledger.org/">CI</a>
<a href="http://stackoverflow.com/questions/tagged/hyperledger-fabric">StackOverflow</a>
{% endblock %}

0 comments on commit 9db5dcb

Please sign in to comment.