Skip to content

Instantly share code, notes, and snippets.

@mba811

mba811/making-dash-doctests-using-sphinx-and-doc2dash.html

Created April 16, 2015 13:26
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save mba811/ca22989a42c63fe47f06 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save mba811/ca22989a42c63fe47f06 to your computer and use it in GitHub Desktop.
Download ZIP
making-dash-doctests-using-sphinx-and-doc2dash
Raw
making-dash-doctests-using-sphinx-and-doc2dash.html
<!DOCTYPE html>
<html>
<head lang="en">
<meta charset="UTF-8">
<title>
Making dash doctests using sphinx and doc2dash | EF
</title>
<link href="//cdnjs.cloudflare.com/ajax/libs/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet">
<link href='http://fonts.googleapis.com/css?family=Inconsolata' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="http://nafiulis.me/theme/css/main.css"/>
<link rel="stylesheet" href="http://nafiulis.me/theme/css/pygment.css"/>
<script src="http://nafiulis.me/theme/js/jquery.min.js"></script>
<script src="http://nafiulis.me/theme/js/main.js"></script>
</head>
<body>
<!--Heading at the top saying "Engineering Fantasy"-->
<div id="header_top">
<div class="title">
<a href="http://nafiulis.me"><span id="engineering">Engineering</span><span id="fantasy">Fantasy</span></a>
</div>
</div>
<button type="button" class="js-menu-trigger sliding-menu-button button-nav">
<img src="https://raw.githubusercontent.com/thoughtbot/refills/master/source/images/menu-white.png" alt="Menu Icon">
</button>
<!--Navigation Bar-->
<nav class="js-menu sliding-menu-content">
<span class="section-header">Pages</span>
<ul>
<li><a href="http://nafiulis.me">Home</a></li>
<li><a href="http://nafiulis.me/tags.html">Tags</a></li>
<li><a href="http://nafiulis.me/pages/about-me.html">About Me</a></li>
</ul>
<span class="section-header">Categories</span>
<ul>
<li><a href="http://nafiulis.me/category/anime.html">Anime</a></li>
<li><a href="http://nafiulis.me/category/education.html">Education</a></li>
<li><a href="http://nafiulis.me/category/productivity.html">Productivity</a></li>
<li><a href="http://nafiulis.me/category/programming.html">programming</a></li>
<li><a href="http://nafiulis.me/category/rants.html">rants</a></li>
</ul>
</nav>
<div class="js-menu-screen menu-screen"></div>
<!--Main Container-->
<div class="container">
<!--Top most menu-->
<div id="menu">
<div class="left">
<a href="http://nafiulis.me/feeds/all.atom.xml"><i class="fa fa-rss
icon"></i></a>
<a href="https://twitter.com/gamesbrainiac"><i class="fa fa-twitter icon"></i></a>
</div>
<div class="center">
<h1 class="message">Nafiul Islam on casting spells with code</h1>
</div>
<div class="right">
<a href="https://github.com/gamesbrainiac"><i class="fa fa-github icon"></i></a>
<a href="http://stackoverflow.com/users/1624921/games-brainiac"><i class="fa fa-stack-overflow icon"
style="padding-right: 30px"></i></a>
</div>
</div>
<!--Main blog list container-->
<div id="blogroll">
<div class="article-container">
<h1>Making dash doctests using sphinx and doc2dash</h1>
<p class="time">Friday, 24 October 2014</p>
<div class="article-content">
<p>Dash is an offline documentation search engine. I've been using <a class="reference external" href="http://kapeli.com/dash">Dash</a> a lot recently.
It has very fast search and supports many libraries out there.
<a class="reference external" href="zealdocs.org/">Zeal</a> is a free and ope source alternative to Dash that uses Dash doctests for offline documentation
that supports all platforms. Other platform specific tools also exist such as
<a class="reference external" href="http://velocity.silverlakesoftware.com/">Velocity</a> for Windows and <a class="reference external" href="http://lovelydocs.io/">LovelyDocs</a> for
Android.</p>
<p>Dash supports many libraries however, libraries like <tt class="docutils literal">Fabric</tt> and <tt class="docutils literal">requests</tt> are not officially supported; their
dash compatible doctests can be generated though. So, I thought I'd make a quick tutorial on how to generate doctests
for third party libraries:</p>
<div class="external youtube"><iframe width="640" height="360" src="//www.youtube.com/embed/_B6drt8JEH4" frameborder="0"></iframe></div>
</div>
</div>
<div class="post-meta"><span class="meta-type">Category: </span>
<span><a href="http://nafiulis.me/category/programming.html">Programming</a></span>
<span class="meta-type"> Tags: </span>
<span>
<a href="http://nafiulis.me/tag/python.html">python</a>, <a href="http://nafiulis.me/tag/sphinx.html">sphinx</a>, <a href="http://nafiulis.me/tag/dash.html">dash</a>, <a href="http://nafiulis.me/tag/doc2dah.html">doc2dah</a> </span>
</div>
<div id="disqus_thread" style="margin-top: 10px; margin-left: 20px; margin-right: 20px;"></div>
<script type="text/javascript">
/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
var disqus_shortname = 'nafiulisme'; // required: replace example with your forum shortname
/* * * DON'T EDIT BELOW THIS LINE * * */
(function() {
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
</script>
<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
</div>
<!--Footer-->
<div id="footer">
<footer>
Code examples licenced under MIT License
<br/>
Copyright <i class="fa fa-copyright"></i> 2015 Quazi Nafiul Islam
</footer>
</div>
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-55554110-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment