Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Epub improvements #36

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Welcome to the first in this series of smart contract tutorials. Although you wi
2. Has its own token to use for experimenting with smart contracts.
3. Runs even if you are not connected to the internet. This gives you the opportunity to try out "real world" smart contract deployment and method calling in an entirely local setting.

This small local network uses a :doc:`Proof-of-Authority (PoA) consensus algorithm </../../../Architecture Reference/FullNode/PoA/PoA-introduction>`. In fact, the network can run completely standalone, however, more nodes can join the network by simply opening another instance of Cirrus Core (Developer Edition). This network is not a sidechain, the node(s) do not run a sidechain gateway, which means the token created is not pegged to the STRAX and carries no value at all in the real world.
This small local network uses a :doc:`Proof-of-Authority (PoA) consensus algorithm </../../../Architecture-Reference/FullNode/PoA/PoA-introduction>`. In fact, the network can run completely standalone, however, more nodes can join the network by simply opening another instance of Cirrus Core (Developer Edition). This network is not a sidechain, the node(s) do not run a sidechain gateway, which means the token created is not pegged to the STRAX and carries no value at all in the real world.

A significant amount of focus has been put into simplifying the 'setup' process and ensure a consistent development environment for those looking to embark on Smart Contract Development in C# on the Stratis Platform.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ This section of the Academy aims to provide developers with a guide to performin

.. toctree::
:maxdepth: 2
:caption: Contents:
API Reference <API Reference/api>
:caption: Contents:

API Reference <API-Reference/api>
Smart Contracts <SmartContracts/smartcontracts-introduction>

Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,6 @@ Guides contained within this section will relate to how Cold-Staking can be conf
:maxdepth: 2
:caption: Contents:

STRAX Wallet Cold-Staking <STRAX Wallet/Cold-Staking-Guide>
STRAX Wallet Cold-Staking <STRAX-Wallet/Cold-Staking-Guide>
Headless Cold-Staking <Headless/cold-staking-headless-setup>
Docker Example <Headless - Docker/cold-staking-headless-setup>
Docker Example <Headless-Docker/cold-staking-headless-setup>
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ Guides contained within this section will relate to Masternodes provided by Stra
:maxdepth: 2
:caption: Contents:

Creating an InterFlux Masternode <Creating Masternode/creating-a-masternode>
Running an InterFlux Masternode <Running Masternode/running-the-masternode>
Creating an InterFlux Masternode <Creating-Masternode/creating-a-masternode>
Running an InterFlux Masternode <Running-Masternode/running-the-masternode>
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Guides contained within this section will relate to the Stratis Decentralized Ac
:maxdepth: 2
:caption: Contents:

Creating a Proposal <Creating a Proposal/creating-a-proposal>
Creating a Proposal <Creating-a-Proposal/creating-a-proposal>
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ Operation Guides
.. toctree::

Cold-Staking <Cold-Staking/coldstaking-introduction>
Full Node <Full Node/fullnode-introduction>
InterFlux Masternodes <InterFlux Masternodes/masternode-introduction>
Full Node <Full-Node/fullnode-introduction>
InterFlux Masternodes <InterFlux-Masternodes/masternode-introduction>
Sidechains <Sidechain/sidechain-introduction>
Smart Contracts <SmartContracts/smartcontracts-introduction>
Stratis Decentralized Accelerator <SDA/sda-introduction>
STO<STO/sto-introduction>
Token Swap<Token Swap/tokenswap-introduction>
Token Swap<Token-Swap/tokenswap-introduction>
31 changes: 31 additions & 0 deletions source/_themes/stratis_epub_theme/epub-cover.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{#
epub/epub-cover.html
~~~~~~~~~~~~~~~~~~~~

Sample template for the html cover page.

:copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
#}
{% extends "layout.html" %}
{%- block rootrellink %}{% endblock %}
{%- block relbaritems %}{% endblock %}
{%- block sidebarlogo %}{% endblock %}
{%- block linktags %}{% endblock %}
{%- block relbar1 %}{% endblock %}
{%- block sidebar1 %}{% endblock %}
{%- block sidebar2 %}{% endblock %}
{%- block footer %}{% endblock %}

{% block content %}
{#
Ultimately, this should probably just be an image of a nice
cover like a real book instead of building it like a web page
with a bunch of text elements.
#}
<div class="epub-cover">
<h1 style="text-align:center">{{ title }}</h1>
<hr />
<h2 style="text-align:center">Documentation</h2>
</div>
{% endblock %}
2 changes: 2 additions & 0 deletions source/_themes/stratis_epub_theme/theme.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[theme]
inherit = epub
16 changes: 15 additions & 1 deletion source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -158,4 +158,18 @@
]


# -- Extension configuration -------------------------------------------------
# -- Options for Epub output -------------------------------------------

# Might want to exclude the api reference
# epub_exclude_files = [
# 'Developer-Resources/Api-Reference/api.rst'
# ]

epub_use_index = False
epub_show_urls = 'no'

epub_theme = 'stratis_epub_theme'
epub_cover = ('', 'epub-cover.html')


# -- Extension configuration -------------------------------------------------
14 changes: 8 additions & 6 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,11 @@ The Stratis Academy will introduce:
.. toctree::
:maxdepth: 2

Blockchain Overview <Blockchain Overview/blockchain-overview-introduction>
Architecture Reference <Architecture Reference/architecture-reference-introduction>
Developer Resources <Developer Resources/developers-introduction>
Operation Guides <Operation Guides/operation-guides-introduction>

* :ref:`search`
Blockchain Overview <Blockchain-Overview/blockchain-overview-introduction>
Architecture Reference <Architecture-Reference/architecture-reference-introduction>
Developer Resources <Developer-Resources/developers-introduction>
Operation Guides <Operation-Guides/operation-guides-introduction>

.. only:: builder_html

* :ref:`search`