Add doxygen config files used to generate source docs

Update misc docs
This commit is contained in:
thephez 2018-01-04 10:06:31 -05:00
parent 86ea1643e4
commit 61dcf900a6
10 changed files with 2883 additions and 14 deletions

View file

@ -9,8 +9,8 @@ The following quick guides will help you get started:
<!--
+ [Becoming a Contributor](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/become-a-contributor.md)
+ [Working with GitHub](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/working-with-github.md)
-->
+ [Working with GitHub](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/working-with-github.md)
+ [Setting Up Your Environment](https://github.com/thephez/dash.org/blob/master/docs/setting-up-your-environment.md)
<!--
+ [Improving Developer Documentation](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/contributing-to-developer-documentation.md)
@ -18,5 +18,5 @@ The following quick guides will help you get started:
+ [Managing Wallets](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/managing-wallets.md)
+ [Adding Events, Release Notes and Alerts](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/adding-events-release-notes-and-alerts.md)
+ [Adding Blog Posts](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/adding-blog-posts.md)
+ [Miscellaneous / Other](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/miscellaneous.md)
-->
+ [Miscellaneous / Other](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/miscellaneous.md)

View file

@ -8,6 +8,7 @@ Redirections can be defined in ```_config.yml```.
/news: /en/version-history
```
<!--
### Aliases For Contributors
Aliases for contributors are defined in ```_config.yml```.
@ -29,3 +30,4 @@ are some notes about updating those keys based on previous experience:
PR so other people can review it. After the revoked key is uploaded,
discussion about verifying/adding a replacement key may continue at a
slower pace.
-->

View file

@ -2,7 +2,7 @@
#### Preview Small Text Changes
Simple text changes can be previewed live on bitcoin.org. You only need to click
Simple text changes can be previewed live on dash-docs.github.io. You only need to click
anywhere on the page and hold your mouse button for one second. You'll then be
able to edit the page just like a document. Changes will be lost as soon as the
page is refreshed.
@ -11,7 +11,7 @@ page is refreshed.
For anything more than simple text previews, you will need to build the
site. If you can't do this yourself using the instructions below, please
[open a pull request](https://github.com/bitcoin-dot-org/bitcoin.org/compare)
[open a pull request](https://github.com/thephez/dash.org/compare)
with your suggested change and one of the site developers will create a preview
for you.
@ -76,11 +76,11 @@ Use that program to install bundle:
**Install the Ruby dependencies**
Ensure you checked out the site repository as described in [Working with
GitHub](https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/working-with-github.md).
GitHub](https://github.com/thephez/dash.org/blob/master/docs/working-with-github.md).
Then change directory to the top-level of your local repository (replace
`bitcoin.org` with the full path to your local repository clone):
`dash.org` with the full path to your local repository clone):
cd bitcoin.org
cd dash.org
And install the necessary dependencies using Bundle:
@ -91,10 +91,18 @@ long time to install on some systems, so be patient.
Once Bundle completes successfully, you can preview or build the site.
##### Source Code Documentation
The https://dash-docs.github.io site includes Doxygen generated documentation
for the [Dash Core](https://github.com/dashpay/dash/) source code. To
generate it, copy the files from /doxygen into the Dash Core /doc folder
and run `doxygen doc/Doxyfile-dashdocs`. Then copy the output (Dash Core's
/doc/doxygen/html/ folder) into the /en/doxygen/ of this project.
##### Preview The Site
To preview the website in your local browser, make sure you're in the
`bitcoin.org` directory and run the following command:
`dash.org` directory and run the following command:
make preview
@ -110,7 +118,7 @@ Visit the indicated URL in your browser to view the site.
##### Build The Site
To build the site exactly like we do for the deployment server, make
sure you're in the `bitcoin.org` directory and run:
sure you're in the `dash.org` directory and run:
make
@ -172,13 +180,13 @@ For a list of languages, look in the `_translations` directory.
You can publish your previews online to any static hosting service.
[GitHub pages](https://pages.github.com/) is a free service available to
all GitHub users that works with Bitcoin.org's site hierarchy.
all GitHub users that works with dash-docs.github.io's site hierarchy.
Before building a preview site, it is recommended that you set the
environmental variable `BITCOINORG_BUILD_TYPE` to "preview". This will
enable some content that would otherwise be hidden and also create a
robots.txt file that will help prevent the site from being indexed by
search engines and mistaken for the actual Bitcoin.org website.
search engines and mistaken for the actual dash-docs.github.io website.
In the bash shell, you can do this by running the following command line
before building you preview:

View file

@ -14,7 +14,7 @@ repository into a local directory with the following command lines:
```
git clone (url provided by GitHub on your fork's page) bitcoin.org
cd bitcoin.org
git remote add upstream https://github.com/bitcoin-dot-org/bitcoin.org.git
git remote add upstream https://github.com/thephez/dash.org.git
```
**How to send a pull request**
@ -33,6 +33,7 @@ When submitting a pull request, please take required time to discuss your
changes and adapt your work. It is generally a good practice to split unrelated
changes into separate branches and pull requests.
<!--
**Travis Continuous Integration (CI)**
Shortly after your Pull Request (PR) is submitted, a Travis CI job will
@ -61,7 +62,7 @@ builds before opening a pull request, it's really simple:
yellow circle, green checkmark, or red X will appear near the branch
name when the build finishes, and clicking on the icon will take you
to the corresponding build report.
-->
**How to make additional changes in a pull request**
You simply need to push additional commits on the appropriate branch of your
@ -78,6 +79,6 @@ need to re-create the branch and the pull request.
**Advanced GitHub Workflow**
If you continue to contribute to Bitcoin.org beyond a single pull
If you continue to contribute to Dash.org beyond a single pull
request, you may want to use a more [advanced GitHub
workflow](https://gist.github.com/harding/1a99b0bad37f9498709f).

2485
doxygen/Doxyfile-dashdocs Normal file

File diff suppressed because it is too large Load diff

7
doxygen/README.md Normal file
View file

@ -0,0 +1,7 @@
Doxygen Info
=====================
To generate a version of the Dash Core source documentation specific
to this site, copy the files in this folder to the /doc/ folder of
the Dash Core repository and then run `doxygen doc/Doxyfile-dashdocs`
from the root folder of the Dash Core repository.

View file

@ -0,0 +1,34 @@
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<!--BEGIN GENERATE_TREEVIEW-->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
$navpath
<li class="footer">$generatedby
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
</ul>
</div>
<!--END GENERATE_TREEVIEW-->
<!--BEGIN !GENERATE_TREEVIEW-->
<hr class="footer"/><address class="footer"><small>
$generatedby &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
</a> $doxygenversion
</small></address>
<!--END !GENERATE_TREEVIEW-->
</div>
<div class="ddfooter">
<div class="footerlicense">Released under the <a href="http://opensource.org/licenses/mit-license.php" target="_blank">MIT license</a></div>
</div>
</div>
</body>
</html>

106
doxygen/doxygen_header.html Normal file
View file

@ -0,0 +1,106 @@
<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen $doxygenversion"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="$relpath^jquery.js"></script>
<script type="text/javascript" src="$relpath^dynsections.js"></script>
$treeview
$search
$mathjax
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
$extrastylesheet
</head>
<body>
<div class="head"><div>
<!--<a id="menumobile" class="menumobile" onclick="mobileMenuShow(event);" ontouchstart="mobileMenuShow(event);"></a>-->
<a class="logo" href="/en/"><img src="$relpath^$projectlogo" alt="Dash"></img></a>
<ul id="menusimple" class="menusimple menumain" onclick="mobileMenuHover(event);" ontouchstart="mobileMenuHover(event);">
<li><a href="/en/bitcoin-for-developers">Developers</a></li>
<li><a>Documentation</a>
<ul>
<li><a href="/en/developer-guide">Guide</a></li>
<li><a href="/en/developer-reference">Reference</a></li>
<li><a href="/en/developer-examples">Examples</a></li>
<li><a href="/en/developer-glossary">Glossary</a></li>
</ul>
</li>
<li><a>Resources</a>
<ul>
<li><a rel="noopener noreferrer" target="_blank" href="https://www.dash.org/community/">Community</a></li>
<li><a href="/en/vocabulary">Vocabulary</a></li>
</ul>
</li>
</ul>
</div></div>
<div class="body">
<div class="breadcrumbs"></div>
<div id="content" class="content">
<!-- <link rel="stylesheet" href="/css/jquery-ui.min.css"> -->
<h1>Dash Core Source Documentation ($projectnumber)</h1>
<p class="summary">Find detailed information regarding the Dash Core source code.</p>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!--
<!--BEGIN TITLEAREA-->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<!--BEGIN PROJECT_LOGO-->
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
<!--END PROJECT_LOGO-->
<!--BEGIN PROJECT_NAME-->
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">$projectname
<!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
</div>
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
</td>
<!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME-->
<!--BEGIN PROJECT_BRIEF-->
<td style="padding-left: 0.5em;">
<div id="projectbrief">$projectbrief</div>
</td>
<!--END PROJECT_BRIEF-->
<!--END !PROJECT_NAME-->
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN SEARCHENGINE-->
<td>$searchbox</td>
<!--END SEARCHENGINE-->
<!--END DISABLE_INDEX-->
</tr>
</tbody>
</table>
</div>
<!--END TITLEAREA-->
-->
<!-- end header part -->

View file

@ -0,0 +1,226 @@
article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary {
display: block
}
html {
font-family: sans-serif;
-webkit-text-size-adjust: 100%;
-ms-text-size-adjust: 100%
}
.head {
margin: 30px 0 30px 0
}
.head div {
width: 940px;
margin: auto;
position: relative;
z-index: 900
}
.menumobile {
display: none
}
.menusimple {
margin: 0;
position: absolute;
top: 8px;
left: 245px;
padding: 0;
height: 35px
}
.menusimple li {
list-style: none;
display: inline-block;
position: relative;
padding: 0;
margin: 0 3px;
-webkit-border-radius: 5px;
-moz-border-radius: 5px;
border-radius: 5px
}
.menusimple>li a,.menusimple>li a:active,.menusimple>li a:visited,.menusimple>li a:link {
color: #2c6fad
}
.menusimple>li a {
cursor: pointer;
font-family: 'Ubuntu', sans-serif;
font-weight: 300;
font-size: 110%;
display: block;
text-decoration: none;
padding: 6px 10px 4px 10px;
white-space: nowrap
}
.menusimple>li ul {
display: none;
position: absolute;
background-color: #fff;
border: 1px solid #2c6fad;
min-width: 120%;
padding: 5px 0;
margin: 0;
left: 0
}
.menusimple>li>ul li {
margin: 0;
display: block;
width: 100%;
-webkit-border-radius: 0;
-moz-border-radius: 0;
border-radius: 0
}
.menusimple>li>ul>li a {
font-size: 100%;
margin: 1px 0;
padding: 6px 10px 3px 10px
}
.menusimple li:hover,.menusimple li.active {
background-color: #2c6fad
}
.menusimple li:hover>a,.menusimple li.active>a {
color: #fff
}
.menusimple li:hover>ul {
display: block
}
.menusimple.menumain>li:first-child,.menusimple.menumain>li:first-child+li,.menusimple.menumain>li:first-child+li+li+li,.menusimple.menucore>li:first-child,.menusimple.menucore>li:first-child+li+li {
-webkit-border-bottom-left-radius: 0;
-webkit-border-bottom-right-radius: 0;
-moz-border-radius-bottomleft: 0;
-moz-border-radius-bottomright: 0;
border-bottom-left-radius: 0;
border-bottom-right-radius: 0
}
.menusimple.menucore>li:first-child+li+li+li+li a {
font-weight: 700
}
body {
margin: 0
}
body {
color: #646464;
background-color: #f7f7f7
}
body {
font-family: "Helvetica Neue", "Helvetica", Arial, sans-serif;
font-size: 16px;
margin: 0;
padding: 0;
color: #646464;
background-color: #f7f7f7
}
.body {
/*width: 940px;*/
margin: auto;
position: relative
}
/*
.body {
width: auto
}
*/
.logo {
display: block;
margin-left: 40px;
width: 191px;
height: 40px
}
/*
.logo {
position: static;
display: inline-block;
margin: 10px
}
*/
.breadcrumbs {
font-size: 75%;
padding-left: 10px
}
/*
.content {
position: static;
text-align: left;
margin: 0;
padding: 20px 10px;
border-right: 0;
border-left: 0;
-webkit-border-radius: 0;
-moz-border-radius: 0;
border-radius: 0
}
*/
.content {
position: relative;
padding: 30px 40px 40px 40px;
margin: 0 5px;
text-align: justify;
background-color: #fff;
min-height: 400px;
border: 2px solid #ebebeb;
-webkit-border-radius: 6px;
-moz-border-radius: 6px;
border-radius: 6px
}
.summary {
font-size: 125%;
margin-bottom: 40px;
text-align: center
}
.ddfooter {
text-align: center;
width: 940px;
margin: auto
}
.footerlicense {
font-size: 94%;
padding-bottom: 20px
}
h1 {
font-family: 'Ubuntu', sans-serif;
font-weight: 700;
color: #0d579b;
font-size: 160%;
margin-top: 0;
text-align: center
}
#side-nav {
padding:0 6px 0 0;
margin: 0px;
display:block;
position: absolute;
left: auto;
width: 250px;
}

BIN
doxygen/logotop.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 KiB