Skip to content

Commit

Permalink
Moved project web site to code.mindmeldr.com/otrace; switched to sphi…
Browse files Browse the repository at this point in the history
…nx for docs
  • Loading branch information
R. Saravanan committed Oct 7, 2012
1 parent cdb3609 commit c584c46
Show file tree
Hide file tree
Showing 10 changed files with 470 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ otrace: An object-oriented python debugger for nonlinear tracing
*otrace* on `GitHub <https://github.com/mitotic/otrace/downloads>`_.
For a description of the `released version <http://pypi.python.org/pypi/otrace>`_,
see the README file included with the distribution, or the
`project website <http://info.mindmeldr.com/code/otrace>`_.
`project website <http://code.mindmeldr.com/otrace>`_.

Introduction
=============================
Expand Down Expand Up @@ -48,7 +48,7 @@ of the running program.
*otrace* takes control of the terminal, and would not work very
well with programs that read user input directly from the terminal
(or standard input). However, *otrace* has a browser-based graphical
front-end, `GraphTerm <http://info.mindmeldr.com/code/graphterm>`_,
front-end, `GraphTerm <http://code.mindmeldr.com/graphterm>`_,
that can be used with programs that do read from the terminal.

*otrace* does not consume any resources until some tracing action is
Expand Down Expand Up @@ -91,14 +91,14 @@ Support
- Report bugs and other issues using the Github `Issue Tracker <https://github.com/mitotic/otrace/issues>`_.

- A tutorial using a demo program is available in
`docs/GettingStarted.rst <http://info.mindmeldr.com/code/otrace/otrace-getting-started>`_.
`docs/GettingStarted.rst <http://code.mindmeldr.com/otrace/GettingStarted.html>`_.

- `Python and the Holy Grail of Debugging: An Introduction to OTrace (PDF: 1.3MB)
<https://dl.dropbox.com/u/72208800/code/PyTexas12-OTrace-talk.pdf>`_:
slides from a talk given at PyTexas 2012.

- Additional documentation and updates will be made available on the *project home page*,
`info.mindmeldr.com/code/otrace <http://info.mindmeldr.com/code/otrace>`_.
`code.mindmeldr.com/otrace <http://code.mindmeldr.com/otrace>`_.


Using otrace from the command line
Expand Down
2 changes: 1 addition & 1 deletion docs/FAQ.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ available via the ``setuptools`` package.)
Is there a graphical front-end to *otrace*?
============================================

Yes, see `GraphTerm <http://info.mindmeldr.com/code/graphterm>`_
Yes, see `GraphTerm <http://code.mindmeldr.com/graphterm>`_
(Note: If you browse the code for *otrace*, you will notice the
hooks used by the front-end, which could potentially be used by other
graphical front-ends as well.
Expand Down
2 changes: 1 addition & 1 deletion docs/GettingStarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ the prompt ">"). The ``help`` command displays all the available *oshell* comman
Use TAB key for command completion.
Type "help <command>" or "help *" for more info

See http://info.mindmeldr.com/code/otrace for documentation
See http://code.mindmeldr.com/otrace for documentation
globals> help pwd
pwd [-a] # Print current working "directory"

Expand Down
146 changes: 146 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
# Makefile for Sphinx documentation
#

PKGNAME = $(shell basename $(shell dirname $(PWD)))

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = ../www
PAGESDIR = ../../ghp-$(PKGNAME)

# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext

help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"

clean:
-rm -rf $(BUILDDIR)/*

cleanpages:
-rm -rf $(PAGESDIR)/*

pages:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(PAGESDIR)
@echo
@echo "Build finished. The HTML pages are in $(PAGESDIR)."

html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."

json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."

htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."

epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."

latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."

man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."

info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."

gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."

changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."

linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."

doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
1 change: 1 addition & 0 deletions docs/README.rst
27 changes: 27 additions & 0 deletions docs/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{% extends "!layout.html" %}

{%- block extrahead %}
{{ super() }}
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-35342722-1']);
_gaq.push(['_trackPageview']);
</script>
{% endblock %}

{% block footer %}
{{ super() }}
<div class="footer">This page uses <a href="http://analytics.google.com/">
Google Analytics</a> to collect statistics. You can disable it by blocking
the JavaScript coming from www.google-analytics.com.
<script type="text/javascript">
(function() {
var ga = document.createElement('script');
ga.src = ('https:' == document.location.protocol ?
'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
ga.setAttribute('async', 'true');
document.documentElement.firstChild.appendChild(ga);
})();
</script>
</div>
{% endblock %}
Loading

0 comments on commit c584c46

Please sign in to comment.