Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasLecocq committed Sep 3, 2019
1 parent 17ad2fb commit c6e3d9e
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 12 deletions.
10 changes: 5 additions & 5 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -181,14 +181,14 @@ def write_click_help(group='', command='', data=''):

# General information about the project.
project = u'MSNoise'
copyright = u'%i, Lecocq, Caudron & the MSNoise devs' % datetime.datetime.now().year
copyright = u'%i, Lecocq, T. & the MSNoise devs' % datetime.datetime.now().year
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = 'master'# The full version, including alpha/beta/rc tags.
release = 'master'
version = '1.6'# The full version, including alpha/beta/rc tags.
release = '1.6'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -346,7 +346,7 @@ def write_click_help(group='', command='', data=''):
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'MSNoise.tex', u'MSNoise Documentation',
u'Thomas Lecocq, Corentin Caudron and MSNoise Devs', 'manual'),
u'Thomas Lecocq and MSNoise Devs', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
Expand All @@ -372,7 +372,7 @@ def write_click_help(group='', command='', data=''):
# latex_show_urls = 'footnote'

pdf_documents = [
('index', u'msnoise', u'Msnoise Documentation', u'Lecocq, Caudron'),
('index', u'msnoise', u'Msnoise Documentation', u'Lecocq'),
]
# A comma-separated list of custom stylesheets. Example:
pdf_stylesheets = ['sphinx', 'a4']
Expand Down
2 changes: 1 addition & 1 deletion doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Full Installation

.. code-block:: sh
conda install -c conda-forge flask-admin flask-wtf markdown folium
conda install -c conda-forge flask-admin flask-wtf markdown folium pymysql logbook
conda install -c conda-forge obspy
3. Install a MySQL server and MySQL Workbench:
Expand Down
5 changes: 1 addition & 4 deletions doc/releasenotes/msnoise-1.6.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ to announce the new :doc:`msnoise-1.6`. It is a **major** release, with a
massive amount of work since the last one: in `GitHub numbers
<https://github.com/ROBelgium/MSNoise/graphs/contributors?from=2017-04-28&to
=2019-09-03&type=c>`_
, it's over 191 commits and over 4000 lines of code and documentation changed
, it's over 190 commits and over 4000 lines of code and documentation changed
or added!

*End of summer is also a very special period for MSNoise, as it has been 9
Expand All @@ -47,9 +47,6 @@ MSNoise 1.6 introduces a series of **new features** :
demonstrate how users can interact with the MSNoise API, e.g. for creating
custom plots.


.. todo
As always, this version has benefited from outputs/ideas/pull
requests/questions from several users/friends.

Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from setuptools import setup, find_packages

setup(version="1.5.1",
setup(version="1.6",
name='msnoise',
packages=find_packages(),
include_package_data=True,
Expand Down Expand Up @@ -55,7 +55,7 @@
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Topic :: Scientific/Engineering',
'Topic :: Scientific/Engineering :: Physics'],
)

0 comments on commit c6e3d9e

Please sign in to comment.