[Git][debian-gis-team/pyorbital][upstream] New upstream version 1.8.1
Antonio Valentino (@antonio.valentino)
gitlab at salsa.debian.org
Sat Jan 6 15:24:09 GMT 2024
Antonio Valentino pushed to branch upstream at Debian GIS Project / pyorbital
Commits:
d0e56ab4 by Antonio Valentino at 2024-01-06T14:46:28+00:00
New upstream version 1.8.1
- - - - -
15 changed files:
- .github/workflows/ci.yaml
- .github/workflows/deploy-sdist.yaml
- + .readthedocs.yaml
- CHANGELOG.md
- doc/Makefile
- + doc/environment.yaml
- + doc/source/_static/.gitkeep
- + doc/source/_static/main.js
- + doc/source/_static/theme_overrides.css
- doc/source/conf.py
- doc/source/index.rst
- pyorbital/tlefile.py
- pyorbital/version.py
- setup.cfg
- setup.py
Changes:
=====================================
.github/workflows/ci.yaml
=====================================
@@ -28,10 +28,10 @@ jobs:
steps:
- name: Checkout source
- uses: actions/checkout at v3
+ uses: actions/checkout at v4
- name: Setup Conda Environment
- uses: conda-incubator/setup-miniconda at v2
+ uses: conda-incubator/setup-miniconda at v3
with:
miniforge-variant: Mambaforge
miniforge-version: latest
=====================================
.github/workflows/deploy-sdist.yaml
=====================================
@@ -11,7 +11,7 @@ jobs:
steps:
- name: Checkout source
- uses: actions/checkout at v3
+ uses: actions/checkout at v4
- name: Create sdist
shell: bash -l {0}
@@ -19,7 +19,7 @@ jobs:
- name: Publish package to PyPI
if: github.event.action == 'published'
- uses: pypa/gh-action-pypi-publish at v1.8.7
+ uses: pypa/gh-action-pypi-publish at v1.8.11
with:
user: __token__
password: ${{ secrets.pypi_password }}
\ No newline at end of file
=====================================
.readthedocs.yaml
=====================================
@@ -0,0 +1,19 @@
+version: 2
+
+build:
+ os: "ubuntu-20.04"
+ tools:
+ python: "mambaforge-4.10"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+ configuration: doc/source/conf.py
+ fail_on_warning: true
+
+conda:
+ environment: doc/environment.yaml
+
+python:
+ install:
+ - method: pip
+ path: .
=====================================
CHANGELOG.md
=====================================
@@ -1,3 +1,23 @@
+## Version 1.8.1 (2024/01/05)
+
+### Pull Requests Merged
+
+#### Bugs fixed
+
+* [PR 138](https://github.com/pytroll/pyorbital/pull/138) - Update celestrak urls ([139](https://github.com/pytroll/pyorbital/issues/139))
+
+#### Features added
+
+* [PR 137](https://github.com/pytroll/pyorbital/pull/137) - Prettify the RTD pages
+
+#### Documentation changes
+
+* [PR 137](https://github.com/pytroll/pyorbital/pull/137) - Prettify the RTD pages
+* [PR 132](https://github.com/pytroll/pyorbital/pull/132) - Add .readthedocs.yaml
+
+In this release 4 pull requests were closed.
+
+
## Version 1.8.0 (2023/07/12)
### Issues Closed
=====================================
doc/Makefile
=====================================
@@ -12,26 +12,20 @@ PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
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 " 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)"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @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 " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @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)/*
@@ -46,11 +40,6 @@ 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
@@ -76,42 +65,12 @@ qthelp:
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyorbital.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/pyorbital"
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyorbital"
- @echo "# devhelp"
-
-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."
+ @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+ "run these through (pdf)latex."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
=====================================
doc/environment.yaml
=====================================
@@ -0,0 +1,25 @@
+name: readthedocs
+channels:
+ - conda-forge
+dependencies:
+ - python=3.11
+ - pip
+ - dask
+ - dask-image
+ - defusedxml
+ - numba
+ - numpy
+ - scipy
+ - requests
+ - pytest
+ - pyproj
+ - setuptools
+ - setuptools_scm
+ - sphinx
+ - sphinx_rtd_theme
+ - sphinxcontrib-apidoc
+ - trollsift
+ - xarray
+ - pip:
+ - graphviz
+ - .. # relative path to the pyorbital project
=====================================
doc/source/_static/.gitkeep
=====================================
=====================================
doc/source/_static/main.js
=====================================
@@ -0,0 +1,6 @@
+$(document).ready( function () {
+ $('table.datatable').DataTable( {
+ "paging": false,
+ "dom": 'lfitp'
+} );
+} );
=====================================
doc/source/_static/theme_overrides.css
=====================================
@@ -0,0 +1,13 @@
+/* override table width restrictions */
+ at media screen and (min-width: 767px) {
+
+ .wy-table-responsive table td {
+ /* !important prevents the common CSS stylesheets from overriding
+ this as on RTD they are loaded after this stylesheet */
+ white-space: normal !important;
+ }
+
+ .wy-table-responsive {
+ overflow: visible !important;
+ }
+}
=====================================
doc/source/conf.py
=====================================
@@ -10,6 +10,7 @@
#
# All configuration values have a default; values that are commented out
# serve to show the default.
+"""Configurations for sphinx based documentation."""
import sys
import os
@@ -25,11 +26,11 @@ from pyorbital import __version__ # noqa
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# #needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.coverage']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.coverage', 'sphinx.ext.napoleon']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['.templates']
@@ -38,14 +39,14 @@ templates_path = ['.templates']
source_suffix = '.rst'
# The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# #source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'pyorbital'
-copyright = u'2012-2015, 2018, The Pytroll crew'
+copyright = u'2012-2023, The Pytroll crew'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -58,114 +59,125 @@ release = __version__
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
-#language = None
+# #language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
-#today = ''
+# #today = ''
# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# #today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# #default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# #add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
-#add_module_names = True
+# #add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
-#show_authors = False
+# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# #modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-html_theme = 'default'
+# The theme to use for HTML and HTML Help pages. Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = "sphinx_rtd_theme"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
-#html_theme_options = {}
+# #html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# #html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
-#html_title = None
+# #html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
+# #html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
-#html_logo = None
+# #html_logo = None
# 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
# pixels large.
-#html_favicon = None
+# #html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['.static']
+html_static_path = ["_static"]
+
+html_css_files = [
+ "theme_overrides.css", # override wide tables in RTD theme
+ "https://cdn.datatables.net/1.10.23/css/jquery.dataTables.min.css",
+]
+
+html_js_files = [
+ "https://cdn.datatables.net/1.10.23/js/jquery.dataTables.min.js",
+ "main.js",
+]
+
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# #html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
-#html_use_smartypants = True
+# #html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# #html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
-#html_additional_pages = {}
+# #html_additional_pages = {}
# If false, no module index is generated.
-#html_domain_indices = True
+# #html_domain_indices = True
# If false, no index is generated.
-#html_use_index = True
+# #html_use_index = True
# If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# #html_split_index = False
# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# #html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# #html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# #html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# #html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# #html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'pyorbitaldoc'
@@ -174,10 +186,10 @@ htmlhelp_basename = 'pyorbitaldoc'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
+# #latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+# #latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
@@ -188,26 +200,26 @@ latex_documents = [
# The name of an image file (relative to this directory) to place at the top of
# the title page.
-#latex_logo = None
+# #latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
-#latex_use_parts = False
+# #latex_use_parts = False
# If true, show page references after internal links.
-#latex_show_pagerefs = False
+# #latex_show_pagerefs = False
# If true, show URL addresses after external links.
-#latex_show_urls = False
+# #latex_show_urls = False
# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
+# #latex_preamble = ''
# Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# #latex_appendices = []
# If false, no module index is generated.
-#latex_domain_indices = True
+# #latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
=====================================
doc/source/index.rst
=====================================
@@ -1,8 +1,3 @@
-.. pyorbital documentation master file, created by
- sphinx-quickstart on Mon Oct 3 08:48:29 2011.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
Pyorbital
=========
@@ -92,10 +87,10 @@ specific TLE file is provided or if the :envvar:`TLES` environment variable is n
TLE download and database
-~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^
The historical TLE files can be requested from
-`celestrak <https://celestrak.com/NORAD/archives/request.php>`_.
+`celestrak's request page <https://celestrak.com/NORAD/archives/request.php>`_.
There is also a script, ``fetch_tles.py``, that can be used to collect
TLE data from several locations. The currently supported locations
@@ -197,21 +192,21 @@ API
---
Orbital computations
-~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^
.. automodule:: pyorbital.orbital
:members:
:undoc-members:
TLE handling
-~~~~~~~~~~~~
+^^^^^^^^^^^^
.. automodule:: pyorbital.tlefile
:members:
:undoc-members:
Astronomical computations
-~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: pyorbital.astronomy
:members:
=====================================
pyorbital/tlefile.py
=====================================
@@ -37,16 +37,18 @@ import sqlite3
from xml.etree import ElementTree as ET
from itertools import zip_longest
-
-TLE_URLS = ('https://celestrak.org/NORAD/elements/active.txt',
- 'https://celestrak.org/NORAD/elements/weather.txt',
- 'https://celestrak.org/NORAD/elements/resource.txt',
- 'https://celestrak.org/NORAD/elements/cubesat.txt',
- 'https://celestrak.org/NORAD/elements/stations.txt',
- 'https://celestrak.org/NORAD/elements/sarsat.txt',
- 'https://celestrak.org/NORAD/elements/noaa.txt',
- 'https://celestrak.org/NORAD/elements/amateur.txt',
- 'https://celestrak.org/NORAD/elements/engineering.txt')
+TLE_GROUPS = ('active',
+ 'weather',
+ 'resource',
+ 'cubesat',
+ 'stations',
+ 'sarsat',
+ 'noaa',
+ 'amateur',
+ 'engineering')
+
+TLE_URLS = [f'https://celestrak.org/NORAD/elements/gp.php?GROUP={group}&FORMAT=tle'
+ for group in TLE_GROUPS]
LOGGER = logging.getLogger(__name__)
=====================================
pyorbital/version.py
=====================================
@@ -26,9 +26,9 @@ def get_keywords():
# setup.py/versioneer.py will grep for the variable names, so they must
# each be defined on a line of their own. _version.py will just call
# get_keywords().
- git_refnames = " (HEAD -> main, tag: v1.8.0)"
- git_full = "aa3a2169cb695068fd57cb257a5070736cc50098"
- git_date = "2023-07-12 08:37:37 -0500"
+ git_refnames = " (HEAD -> main, tag: v1.8.1)"
+ git_full = "e76264b5d972a620d1abf7ef3e1627eb628b1120"
+ git_date = "2024-01-05 08:23:50 -0600"
keywords = {"refnames": git_refnames, "full": git_full, "date": git_date}
return keywords
=====================================
setup.cfg
=====================================
@@ -17,6 +17,7 @@ versionfile_build =
tag_prefix = v
[coverage:run]
+relative_files = True
omit =
pyorbital/version.py
versioneer.py
=====================================
setup.py
=====================================
@@ -57,5 +57,6 @@ setup(name='pyorbital',
scripts=['bin/fetch_tles.py', ],
install_requires=['numpy>=1.19.0', 'scipy', 'requests'],
python_requires='>=3.9',
+ extras_require={"doc": ["sphinx", "sphinx_rtd_theme", "sphinxcontrib-apidoc"]},
zip_safe=False,
)
View it on GitLab: https://salsa.debian.org/debian-gis-team/pyorbital/-/commit/d0e56ab422e13d6f8ddfcce17df8e85318a2af53
--
View it on GitLab: https://salsa.debian.org/debian-gis-team/pyorbital/-/commit/d0e56ab422e13d6f8ddfcce17df8e85318a2af53
You're receiving this email because of your account on salsa.debian.org.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://alioth-lists.debian.net/pipermail/pkg-grass-devel/attachments/20240106/56c90051/attachment-0001.htm>
More information about the Pkg-grass-devel
mailing list