-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
mdr0id
committed
Jul 6, 2018
0 parents
commit e64d505
Showing
271 changed files
with
28,134 additions
and
0 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 = sphinx-build | ||
SPHINXPROJ = ZCashDocumentation | ||
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# ReadtheDocs Overview | ||
[![Documentation Status](https://readthedocs.org/projects/zcash/badge/?version=english-docs)](http://zcash.readthedocs.io/en/english-docs/?badge=english-docs) | ||
|
||
|
||
This repo contains material, code, and resources for Zcash ReadtheDocs environment. It is intended as a staging area for existing | ||
documentation to be updated during the ReadtheDocs migration. Additionally, it provides a local and non-local development environment using [Sphinx](http://www.sphinx-doc.org/en/master/) | ||
and [ReadtheDocs](https://readthedocs.org/). | ||
|
||
## Installation | ||
If you are using Ubuntu 16.04, please install the required packages below: | ||
|
||
```bash | ||
sudo apt-get install python-pip | ||
pip install sphinx_rtd_theme sphinx sphinx-autobuild sphinx_fontawesome | ||
``` | ||
|
||
## Setup | ||
To use the Zcash ReadtheDocs development environment, please issue the following command: | ||
|
||
```bash | ||
git clone ssh://[email protected]/mdr0id/zcash.git | ||
git checkout zc_readthedocs | ||
cd ./zcash/doc | ||
``` | ||
|
||
Here you will notice some important directories and files: | ||
|
||
:file_folder: bitcoin-release-notes | ||
|
||
:file_folder: build | ||
|
||
:page_facing_up: Doxyfile | ||
|
||
:page_facing_up: make.bat | ||
|
||
:page_facing_up: Makefile | ||
|
||
:file_folder: man | ||
|
||
:file_folder: release-notes | ||
|
||
:file_folder: source | ||
|
||
### Local Development | ||
There are several options to create targets from the ReadtheDocs development environment. The core functionality | ||
is maintained in the below files, located in ```./doc/source/``` : | ||
|
||
:page_facing_up: conf.py (configuration file used to support local/non-local environment) | ||
|
||
:page_facing_up: index.rst (root page for ReadtheDocs to generate sibling documents) | ||
|
||
#### Build | ||
If you are current in the ```doc``` dir issue the following command to generate a local html instance of ReadtheDocs: | ||
|
||
```bash | ||
make html | ||
``` | ||
You can find the generated root html file in ```./doc/build/html/``` as ```index.html``` | ||
|
||
### Non-Local Development | ||
This non-local implementation of Zcash ReadtheDocs found [here](http://zcash.readthedocs.io/en/latest/index.html) | ||
|
||
The dashboard corresponding to this environment is located [here](https://readthedocs.org/projects/zcash/) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# This script was created to convert a directory full | ||
# of markdown files into rst equivalents. It uses | ||
# pandoc to do the conversion. | ||
# | ||
# 1. Install pandoc from http://johnmacfarlane.net/pandoc/ | ||
# 2. Copy this script into the directory containing the .md files | ||
# 3. Ensure that the script has execute permissions | ||
# 4. Run the script | ||
# | ||
# By default this will keep the original .md file | ||
|
||
FILES=*.md | ||
for f in $FILES | ||
do | ||
# extension="${f##*.}" | ||
filename="${f%.*}" | ||
echo "Converting $f to $filename.rst" | ||
`pandoc $f -t rst -o $filename.rst` | ||
# uncomment this line to delete the source file. | ||
# rm $f | ||
done |
Oops, something went wrong.