Commit f3c3cbbd authored by Andrew Quinn's avatar Andrew Quinn
Browse files

Merge branch 'docstrings_update' into 'master' 

major update to stft docstrings and introduce docstring_utils

See merge request !83
parents 1104d509 3e58b5ad

.gitlab-ci.yml

+8 −49
Original line number Diff line number Diff line
@@ -6,57 +6,16 @@ before_script: 
  - apt upgrade -q -y

  - pip install .[full]



stages:

  - build



build37:

  stage: build

  image: python:3.7

  script:

    - flake8

    - make clean

    - make all

    - pytest

  artifacts:

    paths:

      - dist/

    expire_in: 1 week



build38:

  stage: build

  image: python:3.8

  script:

    - flake8

    - make clean

    - make all

    - pytest

  artifacts:

    paths:

      - dist/

    expire_in: 1 week



build39:

  stage: build

  image: python:3.9

  script:

    - flake8

    - make clean

    - make all

    - pytest

  artifacts:

    paths:

      - dist/

    expire_in: 1 week





build310:

  stage: build

  image: python:3.10

pytests:

  stage: test

  image: docker.io/python:$PYTHON_VERSIONS

  parallel:

    matrix:

      - PYTHON_VERSIONS: [ "3.8", "3.9", "3.10", "3.11" ]  

  script:

    - flake8

    - make clean

    - make all

    - pytest

    - make all-clean

    - make test

  artifacts:

    paths:

      - dist/

.readthedocs.yaml

0 → 100644
+22 −0
Original line number Diff line number Diff line 
# .readthedocs.yaml

# Read the Docs configuration file

# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details



# Required

version: 1.4



# Set the version of Python and other tools you might need

build:

  os: ubuntu-22.04

  tools:

    python: "3.11"



# Build documentation in the docs/ directory with Sphinx

sphinx:

  configuration: docs/conf.py



# We recommend specifying your dependencies to enable reproducible builds:

# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html

# python:

#   install:

#   - requirements: docs/requirements.txt
 
 No newline at end of file

Makefile

+20 −13
Original line number Diff line number Diff line
@@ -2,45 +2,52 @@ 


# There must be a nicer way to do this

PYTHONARCH=$(shell python utils/pythonarch)

PYTHONARCH3=$(shell python3 utils/pythonarch)

PYTHONARCH3=$(shell python utils/pythonarch)



BINS=$(shell python setup.py --list-scripts)



DEVELVERSION ?= 0.DEVEL.$(shell date +%Y%m%d%H%M)

RELEASEVERSION ?= $(DEVELVERSION)



all: all-python3

all: all-python



doc: doc-html



doc-html: all

	python3 setup.py build_sphinx

	python setup.py build_sphinx



clean:

	python3 setup.py clean

	python setup.py clean

	# Stupid python setuptools don't even clean the build directory

	rm -fr build

	rm -fr doc/build

	rm -fr sails.egg-info



test3: all-python3

	py.test-3 -c setup.cfg sails

test:

	python -m pytest sails

	coverage html



testv3: all-python3

	py.test-3 -c setup.cfg -v sails

all-python:

	python setup.py build



all-python3:

	python3 setup.py build

all-clean: install-clean

	python setup.py build



install-python3: all-python3

	python3 setup.py install --prefix=$(DESTDIR)/usr

install-clean: clean

	python setup.py install



install-python: all-python

	python setup.py install --prefix=$(DESTDIR)/usr



spell:

	codespell -s --ignore-words=ignore_words.txt `find . -type f -name \*.py`



sphinx:

	sphinx-build -M html doc/source doc/build



# Make single reqs file for readthedocs

# https://github.com/readthedocs/readthedocs.org/issues/1112

reqs:

	cat requirements.txt requirements_dev.txt > requirements_rtd.txt



.PHONY: clean doc doc-html all all-python3 test3 testv3 pythonarch install-python3 codespell
 
.PHONY: clean doc doc-html all all-python test testv pythonarch install-python codespell

doc/source/api.rst

+1 −0
Original line number Diff line number Diff line
@@ -7,6 +7,7 @@ which has its own page: 
.. toctree::

   :maxdepth: 1



   api/stft

   api/simulation

   api/preprocessing

   api/fitting

doc/source/api/stft.rst

0 → 100644
+8 −0
Original line number Diff line number Diff line 
Short-Time Fourier Transforms

#############################



.. autofunction:: sails.stft.periodogram

.. autofunction:: sails.stft.sw_periodogram

.. autofunction:: sails.stft.multitaper

.. autofunction:: sails.stft.sw_multitaper

.. autofunction:: sails.stft.glm_periodogram