Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
- add goatcounter tracking and link to privacy policy
- add @hmacdope to authors in the docs
- update links in README/docs
- fixed double logo in docs
  • Loading branch information
orbeckst committed Aug 19, 2020
1 parent ebe63d4 commit 70383a8
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 10 deletions.
15 changes: 9 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ pytng - A python library to read TNG files!
:target: https://codecov.io/gh/MDAnalysis/pytng


.. Warning::

This package is under development. It is not ready for general use.


This package provides the ``TNGFile`` object to allow simple Pythonic access to data
contained within TNG files:

Expand All @@ -24,10 +29,10 @@ This package contains Python bindings to libtng_ for TNG file format[1_] [2_].
This is used by molecular simulation programs such as Gromacs_ for storing the
topology and results from molecular dynamics simulations.

.. _libtng: https://github.com/gromacs/tng
.. _libtng: https://gitlab.com/gromacs/tng
.. _1: http://link.springer.com/article/10.1007%2Fs00894-010-0948-5
.. _2: http://onlinelibrary.wiley.com/doi/10.1002/jcc.23495/abstract
.. _Gromacs: http://manual.gromacs.org/online/tng.html
.. _Gromacs: http://manual.gromacs.org/


Installation
Expand All @@ -51,9 +56,7 @@ To install the latest development version from source, run
Getting help
============

For help using this library, please drop by the `Github Issue tracker`__

.. _issuetracker: https://github.com/MDAnalysis/pytng/issues
For help using this library, please drop by the `GitHub issue tracker`_.

__ issuetracker_
.. _GitHub issue tracker: https://github.com/MDAnalysis/pytng/issues

11 changes: 11 additions & 0 deletions docs/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{% extends "!layout.html" %}

{% block footer %}
{{ super() }}
<div class="footer"><p>Please see
our <a href="https://www.mdanalysis.org/pages/privacy/">Privacy Policy</a>
to learn how <a href="https://www.mdanalysis.org">MDAnalysis</a> collects data.</p>
<script data-goatcounter="https://mdanalysis.goatcounter.com/count"
async src="//gc.zgo.at/count.js"></script>
</div>
{% endblock %}
9 changes: 5 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,9 @@

# General information about the project.
project = u'pytng'
copyright = u'2017, Max Linke, Richard J Gowers'
author = u'Max Linke, Richard J Gowers'
author = u'Max Linke, Richard J Gowers, Hugo MacDermott-Opeskin'
copyright = u'2017-2020, ' + author


# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -147,7 +148,7 @@

# The name of an image file (relative to this directory) to place at the top
# of the sidebar. --- use theme
html_logo = "_static/logos/mdanalysis-logo-200x150.png"
#html_logo = "_static/logos/mdanalysis-logo-200x150.png"

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
Expand Down Expand Up @@ -192,7 +193,7 @@
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'pytng.tex', u'pytng Documentation',
u'Max Linke, Richard J Gowers', 'manual'),
author, 'manual'),
]


Expand Down

0 comments on commit 70383a8

Please sign in to comment.