Skip to content

Commit

Permalink
Improved doc appeareance
Browse files Browse the repository at this point in the history
  • Loading branch information
hgrecco committed Feb 8, 2014
1 parent ad80e4a commit f10f947
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 41 deletions.
8 changes: 4 additions & 4 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -77,17 +77,17 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pint.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pyvisa.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pint.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyvisa.qhc"

devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/pint"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pint"
@echo "# mkdir -p $$HOME/.local/share/devhelp/pyvisa"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyvisa"
@echo "# devhelp"

epub:
Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/sidebarintro.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ <h3>Other Formats</h3>
</ul>
<h3>Useful Links</h3>
<ul>
<li><a href="https://pypi.python.org/pypi/pyvisa/">Pint @ PyPI</a></li>
<li><a href="https://pypi.python.org/pypi/pyvisa/">PyVISA @ PyPI</a></li>
<li><a href="https://github.com/hgrecco/pyvisa">Code in GitHub</a></li>
<li><a href="https://github.com/hgrecco/pyvisa/issues">Issue Tracker</a></li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/sidebarlogo.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ <h3>Other Formats</h3>
</ul>
<h3>Useful Links</h3>
<ul>
<li><a href="https://pypi.python.org/pypi/pyvisa/">Pint @ PyPI</a></li>
<li><a href="https://pypi.python.org/pypi/pyvisa/">PyVISA @ PyPI</a></li>
<li><a href="https://github.com/hgrecco/pyvisa">Code in GitHub</a></li>
<li><a href="https://github.com/hgrecco/pyvisa/issues">Issue Tracker</a></li>
</ul>
Expand Down
19 changes: 1 addition & 18 deletions docs/_themes/sphinx_rtd_theme/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,28 +110,11 @@
<div>
Python wrapper for the Virtual Instrument Software Architechture library.
You are currently looking at the documentation of version {{ version }}.
<p></p>
</div>
{% include "searchbox.html" %}
</div>

<div class="">
<h3>Other Formats</h3>
<p>
You can download the documentation in other formats as well:
</p>
<ul>
<li><a href="https://media.readthedocs.org/pdf/pyvisa/latest/pyvisa.pdf">as PDF</a>
<li><a href="https://media.readthedocs.org/htmlzip/pyvisa/latest/pyvisa.zip">as ePub</a>
<li><a href="https://media.readthedocs.org/epub/pyvisa/latest/pyvisa.epub">as zipped HTML</a>
</ul>
<h3>Useful Links</h3>
<ul>
<li><a href="https://pypi.python.org/pypi/pyvisa/">PyVISA @ PyPI</a></li>
<li><a href="https://github.com/hgrecco/pyvisa">Code in GitHub</a></li>
<li><a href="https://github.com/hgrecco/pyvisa/issues">Issue Tracker</a></li>
</ul>
</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
{% set toctree = toctree(maxdepth=2, collapse=False, includehidden=True) %}
{% if toctree %}
Expand Down
19 changes: 2 additions & 17 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,25 +48,10 @@
# |version| and |release|, also used in various other places throughout the
# built documents.

__version__ = "unknown"
try:
# try to grab the commit version of our package
__version__ = (subprocess.check_output(["git", "describe"],
cwd=os.path.dirname(os.path.abspath(__file__)))).strip()
except:
# on any error just try to grab the version that is installed on the system
try:
__version__ = pkg_resources.get_distribution(project).version
except:
# we seem to have a local copy without any repository control
# or installed without setuptools
# so the reported version will be __unknown__
pass

version = __version__
version = pkg_resources.get_distribution(project).version
release = version
this_year = datetime.date.today().year
#copyright = '%s, %s' % (this_year, author)
copyright = '%s, %s' % (this_year, author)

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down

0 comments on commit f10f947

Please sign in to comment.