diff --git a/.gitignore b/.gitignore index d1bd55df..83d399d0 100644 --- a/.gitignore +++ b/.gitignore @@ -66,6 +66,8 @@ instance/ # Sphinx documentation docs/_build/ +docs/apidoc/modules.rst +docs/apidoc/xhydro*.rst # PyBuilder target/ diff --git a/.readthedocs.yml b/.readthedocs.yml index 978de8d6..75f2bf1b 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -17,6 +17,7 @@ build: jobs: pre_build: - sphinx-apidoc -o docs/apidoc --private --module-first xhydro + - sphinx-build -M gettext docs docs/_build conda: environment: environment-dev.yml diff --git a/CHANGES.rst b/CHANGES.rst index 68e338a2..408d42f4 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -2,6 +2,15 @@ Changelog ========= + +v0.4.0 (unreleased) +------------------- +Contributors to this version: Trevor James Smith (:user:`Zeitsperre`). + +New features and enhancements +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +* Added French language support to the documentation. (:issue:`53`, :pull:`55`). + v0.3.0 (2023-12-01) ------------------- Contributors to this version: Gabriel Rondeau-Genesse (:user:`RondeauG`), Trevor James Smith (:user:`Zeitsperre`). diff --git a/Makefile b/Makefile index a3531035..9feb7385 100644 --- a/Makefile +++ b/Makefile @@ -22,6 +22,7 @@ endef export PRINT_HELP_PYSCRIPT BROWSER := python -c "$$BROWSER_PYSCRIPT" +LOCALES := docs/locales help: @python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST) @@ -78,13 +79,21 @@ coverage: ## check code coverage quickly with the default Python autodoc: clean-docs ## create sphinx-apidoc files: sphinx-apidoc -o docs/apidoc --private --module-first xhydro +initialize-translations: clean-docs ## initialize translations, ignoring autodoc-generated files + ${MAKE} -C docs gettext + sphinx-intl update -p docs/_build/gettext -d docs/locales -l fr + linkcheck: autodoc ## run checks over all external links found throughout the documentation $(MAKE) -C docs linkcheck docs: autodoc ## generate Sphinx HTML documentation, including API docs - $(MAKE) -C docs html + $(MAKE) -C docs html BUILDDIR="_build/html/en" +ifneq ("$(wildcard $(LOCALES))","") + ${MAKE} -C docs gettext + $(MAKE) -C docs html BUILDDIR="_build/html/fr" SPHINXOPTS="-D language='fr'" +endif ifndef READTHEDOCS - $(BROWSER) docs/_build/html/index.html + $(BROWSER) docs/_build/html/en/html/index.html endif servedocs: docs ## compile the docs watching for changes diff --git a/docs/conf.py b/docs/conf.py old mode 100755 new mode 100644 index e95a7d77..730ccea3 --- a/docs/conf.py +++ b/docs/conf.py @@ -112,6 +112,10 @@ # Usually you set "language" from the command line for these cases. language = "en" +# Set the locales +locale_dirs = ["locales"] +gettext_compact = False + # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path diff --git a/docs/locales/fr/LC_MESSAGES/authors.po b/docs/locales/fr/LC_MESSAGES/authors.po new file mode 100644 index 00000000..a54084b0 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/authors.po @@ -0,0 +1,64 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, Thomas-Charles Fortier Filion +# This file is distributed under the same license as the xHydro package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: xHydro 0.3.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-12-08 12:18-0500\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language: fr\n" +"Language-Team: fr \n" +"Plural-Forms: nplurals=2; plural=(n > 1);\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.12.1\n" + +#: ../../../AUTHORS.rst:3 +msgid "Credits" +msgstr "" + +#: ../../../AUTHORS.rst:6 +msgid "Development Lead" +msgstr "" + +#: ../../../AUTHORS.rst:8 +msgid "" +"Thomas-Charles Fortier Filion `@TC-FF " +"`_" +msgstr "" + +#: ../../../AUTHORS.rst:11 +msgid "Co-Developers" +msgstr "" + +#: ../../../AUTHORS.rst:13 +msgid "" +"Trevor James Smith `@Zeitsperre " +"`_" +msgstr "" + +#: ../../../AUTHORS.rst:14 +msgid "" +"Gabriel Rondeau-Genesse `@RondeauG " +"`_" +msgstr "" + +#: ../../../AUTHORS.rst:15 +msgid "" +"Sébastien Langlois `@sebastienlanglois " +"`_" +msgstr "" + +#: ../../../AUTHORS.rst:18 +msgid "Contributors" +msgstr "" + +#: ../../../AUTHORS.rst:20 +msgid "None yet. Why not be the first?" +msgstr "" diff --git a/docs/locales/fr/LC_MESSAGES/changes.po b/docs/locales/fr/LC_MESSAGES/changes.po new file mode 100644 index 00000000..0284eaa8 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/changes.po @@ -0,0 +1,268 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, Thomas-Charles Fortier Filion +# This file is distributed under the same license as the xHydro package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: xHydro 0.3.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-12-08 12:18-0500\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language: fr\n" +"Language-Team: fr \n" +"Plural-Forms: nplurals=2; plural=(n > 1);\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.12.1\n" + +#: ../../../CHANGES.rst:3 +msgid "Changelog" +msgstr "" + +#: ../../../CHANGES.rst:6 +msgid "v0.3.0 (2023-12-01)" +msgstr "" + +#: ../../../CHANGES.rst:7 +msgid "" +"Contributors to this version: Gabriel Rondeau-Genesse (:user:`RondeauG`)," +" Trevor James Smith (:user:`Zeitsperre`)." +msgstr "" + +#: ../../../CHANGES.rst:10 ../../../CHANGES.rst:45 +msgid "New features and enhancements" +msgstr "" + +#: ../../../CHANGES.rst:11 +msgid "" +"The `xhydro` planification was added to the documentation. (:issue:`39`, " +":pull:`49`)." +msgstr "" + +#: ../../../CHANGES.rst:14 ../../../CHANGES.rst:52 +msgid "Breaking changes" +msgstr "" + +#: ../../../CHANGES.rst:15 +msgid "" +"`xhydro` now adheres to PEPs 517/518/621 using the `flit` backend for " +"building and packaging. (:pull:`50`)." +msgstr "" + +#: ../../../CHANGES.rst:18 ../../../CHANGES.rst:57 +msgid "Bug fixes" +msgstr "" + +#: ../../../CHANGES.rst:19 +msgid "" +"The `return_level` dimension in " +"`xh.frequency_analysis.local.parametric_quantiles()` is now the actual " +"return level, not the quantile. (:issue:`41`, :pull:`43`)." +msgstr "" + +#: ../../../CHANGES.rst:22 ../../../CHANGES.rst:61 +msgid "Internal changes" +msgstr "" + +#: ../../../CHANGES.rst:23 +msgid "" +"Added `xhydro.testing.utils.publish_release_notes()` to help with the " +"release process. (:pull:`37`)." +msgstr "" + +#: ../../../CHANGES.rst:24 +msgid "" +"`xh.frequency_analysis.local.parametric_quantiles()` and " +"`xh.frequency_analysis.local.criteria()` are now lazier. (:issue:`41`, " +":pull:`43`)." +msgstr "" + +#: ../../../CHANGES.rst:32 +msgid "" +"The `cookiecutter` template has been updated to the latest commit via " +"`cruft`. (:pull:`50`):" +msgstr "" + +#: ../../../CHANGES.rst:26 +msgid "`Manifest.in` and `setup.py` have been removed." +msgstr "" + +#: ../../../CHANGES.rst:27 +msgid "" +"`pyproject.toml` has been added, with most package configurations " +"migrated into it." +msgstr "" + +#: ../../../CHANGES.rst:28 +msgid "`HISTORY.rst` has been renamed to `CHANGES.rst`." +msgstr "" + +#: ../../../CHANGES.rst:29 +msgid "" +"`actions-version-updater.yml` has been added to automate the versioning " +"of the package." +msgstr "" + +#: ../../../CHANGES.rst:30 +msgid "" +"`bump-version.yml` has been added to automate patch versioning of the " +"package." +msgstr "" + +#: ../../../CHANGES.rst:31 +msgid "" +"`pre-commit` hooks have been updated to the latest versions; `check-toml`" +" and `toml-sort` have been added to cleanup the `pyproject.toml` file." +msgstr "" + +#: ../../../CHANGES.rst:32 +msgid "" +"`ruff` has been added to the linting tools to replace most `flake8` and " +"`pydocstyle` verifications." +msgstr "" + +#: ../../../CHANGES.rst:35 +msgid "v0.2.0 (2023-10-10)" +msgstr "" + +#: ../../../CHANGES.rst:36 +msgid "" +"Contributors to this version: Trevor James Smith (:user:`Zeitsperre`), " +"Gabriel Rondeau-Genesse (:user:`RondeauG`), Thomas-Charles Fortier Filion" +" (:user:`TC-FF`), Sébastien Langlois (:user:`sebastienlanglois`)" +msgstr "" + +#: ../../../CHANGES.rst:39 +msgid "Announcements" +msgstr "" + +#: ../../../CHANGES.rst:40 +msgid "Support for Python3.8 and lower has been dropped. (:pull:`11`)." +msgstr "" + +#: ../../../CHANGES.rst:41 +msgid "" +"`xHydro` now hosts its documentation on `Read the Docs " +"`_. (:issue:`22`, :pull:`26`)." +msgstr "" + +#: ../../../CHANGES.rst:42 +msgid "" +"Local frequency analysis functions have been added under a new module " +"`xhydro.frequency_analysis`. (:pull:`20`, :pull:`27`)." +msgstr "" + +#: ../../../CHANGES.rst:46 +msgid "" +"GitHub Workflows for automated testing using `tox` have been added. " +"(:pull:`11`)." +msgstr "" + +#: ../../../CHANGES.rst:47 +msgid "" +"Support for various `xscen` functions has been added to compute " +"indicators and various climate change metrics. (:pull:`21`)." +msgstr "" + +#: ../../../CHANGES.rst:48 +msgid "" +"New function `xh.indicators.compute_volume` to convert streamflow data to" +" volumes. (:pull:`20`, :pull:`27`)." +msgstr "" + +#: ../../../CHANGES.rst:49 +msgid "" +"New function `xh.indicators.get_yearly_op` to compute block operation " +"(e.g. block maxima, minima, etc.). (:pull:`20`, :pull:`27`)." +msgstr "" + +#: ../../../CHANGES.rst:53 +msgid "" +"`xHydro` repository has renamed its primary development branch from " +"`master` to `main`. (:pull:`13`)." +msgstr "" + +#: ../../../CHANGES.rst:54 +msgid "`xHydro` now requires a conda environment to be installed. (:pull:`21`)." +msgstr "" + +#: ../../../CHANGES.rst:58 +msgid "N/A" +msgstr "" + +#: ../../../CHANGES.rst:62 +msgid "Added a Pull Request template. (:pull:`14`)." +msgstr "" + +#: ../../../CHANGES.rst:69 +msgid "" +"Various updates to the autogenerated boilerplate (Ouranosinc" +"/cookiecutter-pypackage) via `cruft`. (:pull:`11`, :pull:`12`, " +":pull:`13`):" +msgstr "" + +#: ../../../CHANGES.rst:64 +msgid "" +"General updates to pre-commit hooks, development dependencies, " +"documentation." +msgstr "" + +#: ../../../CHANGES.rst:65 +msgid "Added configurations for Pull Request and Issues templates, Zenodo." +msgstr "" + +#: ../../../CHANGES.rst:66 +msgid "" +"Documentation now makes use of sphinx directives for usernames, issues, " +"and pull request hyperlinks (via sphinx.ext.extlinks). (:issue:`15`)." +msgstr "" + +#: ../../../CHANGES.rst:67 +msgid "GitHub Workflows have been added for automated testing, and publishing." +msgstr "" + +#: ../../../CHANGES.rst:68 +msgid "" +"Some sphinx extensions have been added/enabled (sphinx-codeautolink, " +"sphinx-copybutton)." +msgstr "" + +#: ../../../CHANGES.rst:69 +msgid "Automated testing with tox now updated to use v4.0+ conventions." +msgstr "" + +#: ../../../CHANGES.rst:70 +msgid "Removed all references to travis.ci." +msgstr "" + +#: ../../../CHANGES.rst:71 +msgid "" +"Deployments to TestPyPI and PyPI are now run using GitHub Workflow " +"Environments as a safeguarding mechanism. (:pull:`28`)." +msgstr "" + +#: ../../../CHANGES.rst:72 +msgid "Various cleanups of the environment files. (:issue:`23`, :pull:`30`)." +msgstr "" + +#: ../../../CHANGES.rst:73 +msgid "" +"`xhydro` now uses the trusted publishing mechanism for PyPI and TestPyPI " +"deployment. (:pull:`32`)." +msgstr "" + +#: ../../../CHANGES.rst:74 +msgid "Added tests. (:pull:`27`)." +msgstr "" + +#: ../../../CHANGES.rst:77 +msgid "0.1.2 (2023-05-10)" +msgstr "" + +#: ../../../CHANGES.rst:79 +msgid "First release on PyPI." +msgstr "" diff --git a/docs/locales/fr/LC_MESSAGES/contributing.po b/docs/locales/fr/LC_MESSAGES/contributing.po new file mode 100644 index 00000000..8fccefba --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/contributing.po @@ -0,0 +1,560 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, Thomas-Charles Fortier Filion +# This file is distributed under the same license as the xHydro package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: xHydro 0.3.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-12-08 12:18-0500\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language: fr\n" +"Language-Team: fr \n" +"Plural-Forms: nplurals=2; plural=(n > 1);\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.12.1\n" + +#: ../../../CONTRIBUTING.rst:5 +msgid "Contributing" +msgstr "" + +#: ../../../CONTRIBUTING.rst:7 +msgid "" +"Contributions are welcome, and they are greatly appreciated! Every little" +" bit helps, and credit will always be given." +msgstr "" + +#: ../../../CONTRIBUTING.rst:9 +msgid "You can contribute in many ways:" +msgstr "" + +#: ../../../CONTRIBUTING.rst:12 +msgid "Types of Contributions" +msgstr "" + +#: ../../../CONTRIBUTING.rst:15 +msgid "Report Bugs" +msgstr "" + +#: ../../../CONTRIBUTING.rst:17 +msgid "Report bugs at https://github.com/hydrologie/xhydro/issues." +msgstr "" + +#: ../../../CONTRIBUTING.rst:19 +msgid "If you are reporting a bug, please include:" +msgstr "" + +#: ../../../CONTRIBUTING.rst:21 +msgid "Your operating system name and version." +msgstr "" + +#: ../../../CONTRIBUTING.rst:22 +msgid "" +"Any details about your local setup that might be helpful in " +"troubleshooting." +msgstr "" + +#: ../../../CONTRIBUTING.rst:23 +msgid "Detailed steps to reproduce the bug." +msgstr "" + +#: ../../../CONTRIBUTING.rst:26 +msgid "Fix Bugs" +msgstr "" + +#: ../../../CONTRIBUTING.rst:28 +msgid "" +"Look through the GitHub issues for bugs. Anything tagged with \"bug\" and" +" \"help wanted\" is open to whoever wants to implement it." +msgstr "" + +#: ../../../CONTRIBUTING.rst:31 +msgid "Implement Features" +msgstr "" + +#: ../../../CONTRIBUTING.rst:33 +msgid "" +"Look through the GitHub issues for features. Anything tagged with " +"\"enhancement\" and \"help wanted\" is open to whoever wants to implement" +" it." +msgstr "" + +#: ../../../CONTRIBUTING.rst:36 +msgid "Write Documentation" +msgstr "" + +#: ../../../CONTRIBUTING.rst:38 +msgid "" +"xHydro could always use more documentation, whether as part of the " +"official xHydro docs, in docstrings, or even on the web in blog posts, " +"articles, and such." +msgstr "" + +#: ../../../CONTRIBUTING.rst:41 +msgid "Submit Feedback" +msgstr "" + +#: ../../../CONTRIBUTING.rst:43 +msgid "" +"The best way to send feedback is to file an issue at " +"https://github.com/hydrologie/xhydro/issues." +msgstr "" + +#: ../../../CONTRIBUTING.rst:45 +msgid "If you are proposing a feature:" +msgstr "" + +#: ../../../CONTRIBUTING.rst:47 +msgid "Explain in detail how it would work." +msgstr "" + +#: ../../../CONTRIBUTING.rst:48 +msgid "Keep the scope as narrow as possible, to make it easier to implement." +msgstr "" + +#: ../../../CONTRIBUTING.rst:49 +msgid "" +"Remember that this is a volunteer-driven project, and that contributions " +"are welcome :)" +msgstr "" + +#: ../../../CONTRIBUTING.rst:53 +msgid "Get Started!" +msgstr "" + +#: ../../../CONTRIBUTING.rst:57 +msgid "" +"If you are new to using GitHub and `git`, please read `this guide " +"`_ first." +msgstr "" + +#: ../../../CONTRIBUTING.rst:61 +msgid "" +"Anaconda Python users: Due to the complexity of some packages, the " +"default dependency solver can take a long time to resolve the " +"environment. Consider running the following commands in order to speed up" +" the process::" +msgstr "" + +#: ../../../CONTRIBUTING.rst:66 +msgid "" +"For more information, please see the following link: " +"https://www.anaconda.com/blog/a-faster-conda-for-a-growing-community" +msgstr "" + +#: ../../../CONTRIBUTING.rst:68 +msgid "" +"Alternatively, you can use the `mamba " +"`_ package manager, " +"which is a drop-in replacement for ``conda``. If you are already using " +"`mamba`, replace the following commands with ``mamba`` instead of " +"``conda``." +msgstr "" + +#: ../../../CONTRIBUTING.rst:70 +msgid "" +"Ready to contribute? Here's how to set up ``xhydro`` for local " +"development." +msgstr "" + +#: ../../../CONTRIBUTING.rst:72 +msgid "" +"If you are not already an `xhydro` collaborator, fork the ``xhydro`` repo" +" on GitHub." +msgstr "" + +#: ../../../CONTRIBUTING.rst:73 +msgid "Clone your fork locally::" +msgstr "" + +#: ../../../CONTRIBUTING.rst:77 +msgid "" +"Install your local copy into a development environment. You can create a " +"new Anaconda development environment with::" +msgstr "" + +#: ../../../CONTRIBUTING.rst:83 +msgid "" +"This installs ``xhydro`` in an \"editable\" state, meaning that changes " +"to the code are immediately seen by the environment." +msgstr "" + +#: ../../../CONTRIBUTING.rst:85 +msgid "" +"To ensure a consistent coding style, install the ``pre-commit`` hooks to " +"your local clone::" +msgstr "" + +#: ../../../CONTRIBUTING.rst:89 +msgid "" +"On commit, ``pre-commit`` will check that ``black``, ``blackdoc``, " +"``isort``, ``flake8``, and ``ruff`` checks are passing, perform automatic" +" fixes if possible, and warn of violations that require intervention. If " +"your commit fails the checks initially, simply fix the errors, re-add the" +" files, and re-commit." +msgstr "" + +#: ../../../CONTRIBUTING.rst:91 +msgid "You can also run the hooks manually with::" +msgstr "" + +#: ../../../CONTRIBUTING.rst:95 +msgid "" +"If you want to skip the ``pre-commit`` hooks temporarily, you can pass " +"the ``--no-verify`` flag to `$ git commit`." +msgstr "" + +#: ../../../CONTRIBUTING.rst:97 +msgid "Create a branch for local development::" +msgstr "" + +#: ../../../CONTRIBUTING.rst:101 +msgid "Now you can make your changes locally." +msgstr "" + +#: ../../../CONTRIBUTING.rst:103 +msgid "" +"When you're done making changes, we **strongly** suggest running the " +"tests in your environment or with the help of ``tox``::" +msgstr "" + +#: ../../../CONTRIBUTING.rst:109 +msgid "Commit your changes and push your branch to GitHub::" +msgstr "" + +#: ../../../CONTRIBUTING.rst:115 +msgid "" +"If ``pre-commit`` hooks fail, try re-committing your changes (or, if need" +" be, you can skip them with `$ git commit --no-verify`)." +msgstr "" + +#: ../../../CONTRIBUTING.rst:117 +msgid "" +"Submit a `Pull Request `_ through the GitHub website." +msgstr "" + +#: ../../../CONTRIBUTING.rst:119 +msgid "" +"When pushing your changes to your branch on GitHub, the documentation " +"will automatically be tested to reflect the changes in your Pull Request." +" This build process can take several minutes at times. If you are " +"actively making changes that affect the documentation and wish to save " +"time, you can compile and test your changes beforehand locally with::" +msgstr "" + +#: ../../../CONTRIBUTING.rst:129 +msgid "" +"Once your Pull Request has been accepted and merged to the ``main`` " +"branch, several automated workflows will be triggered:" +msgstr "" + +#: ../../../CONTRIBUTING.rst:131 +msgid "" +"The ``bump-version.yml`` workflow will automatically bump the patch " +"version when pull requests are pushed to the ``main`` branch on GitHub. " +"**It is not recommended to manually bump the version in your branch when " +"merging (non-release) pull requests (this will cause the version to be " +"bumped twice).**" +msgstr "" + +#: ../../../CONTRIBUTING.rst:132 +msgid "" +"`ReadTheDocs` will automatically build the documentation and publish it " +"to the `latest` branch of `xhydro` documentation website." +msgstr "" + +#: ../../../CONTRIBUTING.rst:133 +msgid "" +"If your branch is not a fork (ie: you are a maintainer), your branch will" +" be automatically deleted." +msgstr "" + +#: ../../../CONTRIBUTING.rst:135 +msgid "You will have contributed your first changes to ``xhydro``!" +msgstr "" + +#: ../../../CONTRIBUTING.rst:138 +msgid "Pull Request Guidelines" +msgstr "" + +#: ../../../CONTRIBUTING.rst:140 +msgid "Before you submit a pull request, check that it meets these guidelines:" +msgstr "" + +#: ../../../CONTRIBUTING.rst:142 +msgid "" +"The pull request should include tests and should aim to provide `code " +"coverage `_ for all new " +"lines of code. You can use the ``--cov-report html --cov xhydro`` flags " +"during the call to ``pytest`` to generate an HTML report and analyse the " +"current test coverage." +msgstr "" + +#: ../../../CONTRIBUTING.rst:144 +msgid "" +"If the pull request adds functionality, the docs should also be updated. " +"Put your new functionality into a function with a docstring, and add the " +"feature to the list in ``README.rst``." +msgstr "" + +#: ../../../CONTRIBUTING.rst:146 +msgid "" +"The pull request should work for Python 3.9, 3.10, and 3.11. Check that " +"the tests pass for all supported Python versions." +msgstr "" + +#: ../../../CONTRIBUTING.rst:149 +msgid "Tips" +msgstr "" + +#: ../../../CONTRIBUTING.rst:151 +msgid "To run a subset of tests::" +msgstr "" + +#: ../../../CONTRIBUTING.rst:155 +msgid "To run specific code style checks::" +msgstr "" + +#: ../../../CONTRIBUTING.rst:163 +msgid "" +"To get ``black``, ``isort ``blackdoc``, ``ruff``, and ``flake8`` (with " +"plugins ``flake8-alphabetize`` and ``flake8-rst-docstrings``) simply " +"install them with `pip` (or `conda`) into your environment." +msgstr "" + +#: ../../../CONTRIBUTING.rst:166 +msgid "Versioning/Tagging" +msgstr "" + +#: ../../../CONTRIBUTING.rst:168 +msgid "" +"A reminder for the **maintainers** on how to deploy. This section is only" +" relevant when producing a new point release for the package." +msgstr "" + +#: ../../../CONTRIBUTING.rst:172 +msgid "" +"It is important to be aware that any changes to files found within the " +"``xhydro`` folder (with the exception of ``xhydro/__init__.py``) will " +"trigger the ``bump-version.yml`` workflow. Be careful not to commit " +"changes to files in this folder when preparing a new release." +msgstr "" + +#: ../../../CONTRIBUTING.rst:174 +msgid "Create a new branch from `main` (e.g. `release-0.2.0`)." +msgstr "" + +#: ../../../CONTRIBUTING.rst:175 +msgid "" +"Update the `CHANGES.rst` file to change the `Unreleased` section to the " +"current date." +msgstr "" + +#: ../../../CONTRIBUTING.rst:176 +msgid "" +"Bump the version in your branch to the next version (e.g. `v0.1.0 -> " +"v0.2.0`):" +msgstr "" + +#: ../../../CONTRIBUTING.rst:183 +msgid "Create a pull request from your branch to `main`." +msgstr "" + +#: ../../../CONTRIBUTING.rst:184 +msgid "" +"Once the pull request is merged, create a new release on GitHub. On the " +"main branch, run:" +msgstr "" + +#: ../../../CONTRIBUTING.rst:191 +msgid "" +"This will trigger a GitHub workflow to build the package and upload it to" +" TestPyPI. At the same time, the GitHub workflow will create a draft " +"release on GitHub. Assuming that the workflow passes, the final release " +"can then be published on GitHub by finalizing the draft release." +msgstr "" + +#: ../../../CONTRIBUTING.rst:193 +msgid "" +"Once the release is published, the `publish-pypi.yml` workflow will go " +"into an `awaiting approval` mode on Github Actions. Only authorized users" +" may approve this workflow (notifications will be sent) to trigger the " +"upload to PyPI." +msgstr "" + +#: ../../../CONTRIBUTING.rst:195 +msgid "To generate the release notes, run:" +msgstr "" + +#: ../../../CONTRIBUTING.rst:203 +msgid "" +"This will print the release notes (taken from the `HISTORY.rst` file) to " +"your python console. Copy and paste them into the GitHub release " +"description, keeping only the changes for the current version." +msgstr "" + +#: ../../../CONTRIBUTING.rst:205 +msgid "" +"Once the release is published, it will go into a `staging` mode on Github" +" Actions. Once the tests pass, admins can approve the release (an e-mail " +"will be sent) and it will be published on PyPI." +msgstr "" + +#: ../../../CONTRIBUTING.rst:209 +msgid "" +"Uploads to PyPI can **never** be overwritten. If you make a mistake, you " +"will need to bump the version and re-release the package. If the package " +"uploaded to PyPI is broken, you should modify the GitHub release to mark " +"the package as broken, as well as yank the package (mark the version " +"\"broken\") on PyPI." +msgstr "" + +#: ../../../CONTRIBUTING.rst:212 +msgid "Packaging" +msgstr "" + +#: ../../../CONTRIBUTING.rst:214 +msgid "" +"When a new version has been minted (features have been successfully " +"integrated test coverage and stability is adequate), maintainers should " +"update the pip-installable package (wheel and source release) on PyPI as " +"well as the binary on conda-forge." +msgstr "" + +#: ../../../CONTRIBUTING.rst:217 +msgid "The simple approach" +msgstr "" + +#: ../../../CONTRIBUTING.rst:219 +msgid "" +"The simplest approach to packaging for general support (pip wheels) " +"requires that ``flit`` be installed::" +msgstr "" + +#: ../../../CONTRIBUTING.rst:223 +msgid "" +"From the command line on your Linux distribution, simply run the " +"following from the clone's main dev branch::" +msgstr "" + +#: ../../../CONTRIBUTING.rst:231 +msgid "" +"The new version based off of the version checked out will now be " +"available via `pip` (`$ pip install xhydro`)." +msgstr "" + +#: ../../../CONTRIBUTING.rst:234 +msgid "Releasing on conda-forge" +msgstr "" + +#: ../../../CONTRIBUTING.rst:237 +msgid "Initial Release" +msgstr "" + +#: ../../../CONTRIBUTING.rst:241 +msgid "" +"Before preparing an initial release on conda-forge, we *strongly* suggest" +" consulting the following links:" +msgstr "" + +#: ../../../CONTRIBUTING.rst:240 +msgid "https://conda-forge.org/docs/maintainer/adding_pkgs.html" +msgstr "" + +#: ../../../CONTRIBUTING.rst:241 +msgid "https://github.com/conda-forge/staged-recipes" +msgstr "" + +#: ../../../CONTRIBUTING.rst:243 +msgid "" +"In order to create a new conda build recipe, to be used when proposing " +"packages to the conda-forge repository, we strongly suggest using the " +"``grayskull`` tool::" +msgstr "" + +#: ../../../CONTRIBUTING.rst:248 +msgid "" +"For more information on ``grayskull``, please see the following link: " +"https://github.com/conda/grayskull" +msgstr "" + +#: ../../../CONTRIBUTING.rst:252 +msgid "" +"Before updating the main conda-forge recipe, we echo the conda-forge " +"documentation and *strongly* suggest performing the following checks:" +msgstr "" + +#: ../../../CONTRIBUTING.rst:251 +msgid "" +"Ensure that dependencies and dependency versions correspond with those of" +" the tagged version, with open or pinned versions for the `host` " +"requirements." +msgstr "" + +#: ../../../CONTRIBUTING.rst:252 +msgid "" +"If possible, configure tests within the conda-forge build CI (e.g. " +"`imports: xhydro`, `commands: pytest xhydro`)." +msgstr "" + +#: ../../../CONTRIBUTING.rst:255 +msgid "Subsequent releases" +msgstr "" + +#: ../../../CONTRIBUTING.rst:257 +msgid "" +"If the conda-forge feedstock recipe is built from PyPI, then when a new " +"release is published on PyPI, `regro-cf-autotick-bot` will open Pull " +"Requests automatically on the conda-forge feedstock. It is up to the " +"conda-forge feedstock maintainers to verify that the package is building " +"properly before merging the Pull Request to the main branch." +msgstr "" + +#: ../../../CONTRIBUTING.rst:260 +msgid "Building sources for wide support with `manylinux` image" +msgstr "" + +#: ../../../CONTRIBUTING.rst:263 +msgid "" +"This section is for building source files that link to or provide links " +"to C/C++ dependencies. It is not necessary to perform the following when " +"building pure Python packages." +msgstr "" + +#: ../../../CONTRIBUTING.rst:266 +msgid "" +"In order to do ensure best compatibility across architectures, we suggest" +" building wheels using the `PyPA`'s `manylinux` docker images (at time of" +" writing, we endorse using `manylinux_2_24_x86_64`)." +msgstr "" + +#: ../../../CONTRIBUTING.rst:269 +msgid "With `docker` installed and running, begin by pulling the image::" +msgstr "" + +#: ../../../CONTRIBUTING.rst:273 +msgid "" +"From the xhydro source folder we can enter into the docker container, " +"providing access to the `xhydro` source files by linking them to the " +"running image::" +msgstr "" + +#: ../../../CONTRIBUTING.rst:277 +msgid "" +"Finally, to build the wheel, we run it against the provided Python3.9 " +"binary::" +msgstr "" + +#: ../../../CONTRIBUTING.rst:281 +msgid "" +"This will then place two files in `xhydro/dist/` (\"xhydro-1.2.3-py3" +"-none-any.whl\" and \"xhydro-1.2.3.tar.gz\"). We can now leave our docker" +" container (`$ exit`) and continue with uploading the files to PyPI::" +msgstr "" diff --git a/docs/locales/fr/LC_MESSAGES/index.po b/docs/locales/fr/LC_MESSAGES/index.po new file mode 100644 index 00000000..12f394ee --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/index.po @@ -0,0 +1,28 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, Thomas-Charles Fortier Filion +# This file is distributed under the same license as the xHydro package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: xHydro 0.3.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-12-08 12:18-0500\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language: fr\n" +"Language-Team: fr \n" +"Plural-Forms: nplurals=2; plural=(n > 1);\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.12.1\n" + +#: ../../index.rst:4 +msgid "Contents:" +msgstr "" + +#: ../../index.rst:2 +msgid "Welcome to xHydro's documentation!" +msgstr "" diff --git a/docs/locales/fr/LC_MESSAGES/installation.po b/docs/locales/fr/LC_MESSAGES/installation.po new file mode 100644 index 00000000..c43b5027 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/installation.po @@ -0,0 +1,87 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, Thomas-Charles Fortier Filion +# This file is distributed under the same license as the xHydro package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: xHydro 0.3.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-12-08 12:18-0500\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language: fr\n" +"Language-Team: fr \n" +"Plural-Forms: nplurals=2; plural=(n > 1);\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.12.1\n" + +#: ../../installation.rst:3 +msgid "Installation" +msgstr "" + +#: ../../installation.rst:6 +msgid "Stable release" +msgstr "" + +#: ../../installation.rst:7 +msgid "" +"Due to the complexity of the install process of some dependencies, we " +"strongly recommend installing `xhydro` in an Anaconda Python environment." +" To create a working environment and install xHydro, copy the " +"`environment.yml` file from the root of the repository and run the " +"following commands:" +msgstr "" + +#: ../../installation.rst:16 +msgid "" +"This is the preferred method to install `xHydro`, as it will always " +"install the most recent stable release." +msgstr "" + +#: ../../installation.rst:18 +msgid "" +"If for some reason you wish to install the `PyPI` version of `xhydro` " +"into an existing Anaconda environment (*not recommended if requirements " +"are not met*), only run the last command above." +msgstr "" + +#: ../../installation.rst:20 +msgid "" +"If you don't have `pip`_ installed, this `Python installation guide`_ can" +" guide you through the process." +msgstr "" + +#: ../../installation.rst:26 +msgid "From sources" +msgstr "" + +#: ../../installation.rst:27 +msgid "" +"`xHydro` is still under active development and the latest features might " +"not yet be available on `PyPI`. To install the latest development " +"version, you can install `xHydro` directly from the `Github repo`_." +msgstr "" + +#: ../../installation.rst:30 +msgid "You can either clone the public repository:" +msgstr "" + +#: ../../installation.rst:36 +msgid "Or download the `tarball`_:" +msgstr "" + +#: ../../installation.rst:42 +msgid "" +"Once you have a copy of the source, you can create a working environment " +"and install `xHydro` in it:" +msgstr "" + +#: ../../installation.rst:50 +msgid "" +"When new changes are made to the `Github repo`_, you can update your " +"local copy using:" +msgstr "" diff --git a/docs/locales/fr/LC_MESSAGES/notebooks/local_frequency_analysis.po b/docs/locales/fr/LC_MESSAGES/notebooks/local_frequency_analysis.po new file mode 100644 index 00000000..c30f3aaf --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/notebooks/local_frequency_analysis.po @@ -0,0 +1,251 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, Thomas-Charles Fortier Filion +# This file is distributed under the same license as the xHydro package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: xHydro 0.3.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-12-08 12:18-0500\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language: fr\n" +"Language-Team: fr \n" +"Plural-Forms: nplurals=2; plural=(n > 1);\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.12.1\n" + +#: ../../notebooks/local_frequency_analysis.ipynb:9 +msgid "Frequency analysis module" +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:1541 +msgid "" +"Data type cannot be displayed: application/javascript, " +"application/vnd.holoviews_load.v0+json" +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:1805 +msgid "" +"Data type cannot be displayed: application/vnd.holoviews_load.v0+json, " +"application/javascript" +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:1870 +msgid "Extracting and preparing the data" +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:1872 +msgid "" +"For this example, we'll conduct a frequency analysis using historical " +"time series from various sites. We begin by obtaining a dataset " +"comprising hydrological information. Here, we use the `xdataset " +"`__" +" library to acquire hydrological data from the `Ministère de " +"l'Environnement, de la Lutte contre les changements climatiques, de la " +"Faune et des Parcs `__ in Quebec, Canada. Specifically, " +"our query focuses on stations with IDs beginning with ``020``, possessing" +" a natural flow pattern and limited to streamflow data." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:1875 +msgid "" +"Users may prefer to generate their own ``xarray.DataArray`` using their " +"individual dataset. At a minimum, the ``xarray.DataArray`` used for " +"frequency analysis has to follow these principles:" +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:1877 +msgid "The dataset needs a ``time`` dimension." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:1878 +msgid "" +"If there is a spatial dimension, such as ``id`` in the example below, it " +"needs an attribute ``cf_role`` with ``timeseries_id`` as its value." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:1879 +msgid "" +"The variable will at the very least need a ``units`` attribute, although " +"other attributes such as ``long_name`` and ``cell_methods`` are also " +"expected by ``xclim`` (which is called at various points during the " +"frequency analysis) and warnings will be generated if they are missing." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:2590 +msgid "Customizing the analysis settings" +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:2593 +msgid "a) Defining seasons" +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:2595 +msgid "" +"We can define seasons using indexers that are compatible with " +"``xclim.core.calendar.select_time``. There are currently four accepted " +"types of indexers:" +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:2597 +msgid "``month``, followed by a sequence of month numbers." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:2598 +msgid "``season``, followed by one or more of 'DJF', 'MAM', 'JJA' and 'SON'." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:2599 +msgid "" +"``doy_bounds``, followed by a sequence representing the inclusive bounds " +"of the period to be considered (start, end)." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:2600 +#, python-format +msgid "" +"``date_bounds``, which is the same as above, but using a month-day " +"(%m-%d) format." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:2602 +msgid "" +"For the purpose of getting block maxima through " +"``xhydro.indicators.get_yearly_op``, the indexers need to be grouped " +"within a dictionary, with the key being the label to be given to the " +"requested period of the year. A second key can be used to instruct on the" +" resampling frequency, for example to wrap around the year for winter." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:2632 +msgid "b) Getting block maxima" +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:2634 +msgid "" +"Upon selecting each desired season, we can extract block maxima " +"timeseries from every station using ``xhydro.indicators.get_yearly_op``. " +"The main arguments are:" +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:2636 +msgid "" +"``op``: the operation to compute. One of \"max\", \"min\", \"mean\", " +"\"sum\"." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:2637 +msgid "``input_var``: the name of the variable. Defaults to \"streamflow\"." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:2638 +msgid "" +"``window``: the size of the rolling window. A \"mean\" is performed on " +"the rolling window prior to the ``op`` operation." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:2639 +msgid "" +"``timeargs``: as defined previously. Leave at ``None`` to get the annual " +"maxima." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:2640 +msgid "" +"``missing`` and ``missing_options``: to define tolerances for missing " +"data. See `this page `__ for more information." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:2641 +msgid "" +"``interpolate_na``: whether to interpolate missing data prior to the " +"``op`` operation. Only used for ``sum``." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:2652 +msgid "The function returns a ``xarray.Dataset`` with 1 variable per indexer." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:3642 +msgid "c) Using custom seasons per year or per station" +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:3644 +msgid "" +"Using individualized date ranges for each year or each catchment is not " +"explicitely supported, so users should instead mask their data prior to " +"calling ``get_yearly_op``. Note that when doing this, ``missing`` should " +"be adjusted accordingly." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:4050 +msgid "d) Computing volumes" +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:4052 +msgid "" +"The frequency analysis can also be performed on volumes, using a similar " +"workflow. The main difference is that if we're starting from streamflow, " +"we'll first need to convert them into volumes using " +"``xhydro.indicators.compute_volume``. Also, if required, " +"``get_yearly_op`` has an argument ``interpolate_na`` that can be used to " +"interpolate missing data prior to the sum." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:4291 +msgid "Local frequency analysis" +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:4293 +msgid "" +"Once we have our yearly maximums (or volumes/minimums), the first step in" +" a local frequency analysis is to call ``xhfa.local.fit`` to obtain " +"distribution parameters. The options are:" +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:4295 +msgid "" +"``distributions``: list of `SciPy distributions " +"`__. Defaults to [\"expon\", \"gamma\", \"genextreme\", " +"\"genpareto\", \"gumbel_r\", \"pearson3\", \"weibull_min\"]." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:4296 +msgid "``min_years``: minimum number of years required to fit the data." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:4297 +msgid "``method``: fitting method. Defaults to the maximum likelihood." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:5004 +msgid "" +"Information Criteria such as the AIC, BIC, and AICC are useful to " +"determine which statistical distribution is better suited to a given " +"location. These three criteria can be computed using " +"``xhfa.local.criteria``." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:5710 +msgid "" +"Finally, return periods can be obtained using " +"``xhfa.local.parametric_quantiles``. The options are:" +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:5712 +msgid "``t``: the return period(s) in years." +msgstr "" + +#: ../../notebooks/local_frequency_analysis.ipynb:5713 +msgid "" +"``mode``: whether the return period is the probability of exceedance " +"(max) or non-exceedance (min). Defaults to ``max``." +msgstr "" diff --git a/docs/locales/fr/LC_MESSAGES/planification.po b/docs/locales/fr/LC_MESSAGES/planification.po new file mode 100644 index 00000000..f57a8fa4 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/planification.po @@ -0,0 +1,30 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, Thomas-Charles Fortier Filion +# This file is distributed under the same license as the xHydro package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: xHydro 0.3.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-12-08 12:18-0500\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language: fr\n" +"Language-Team: fr \n" +"Plural-Forms: nplurals=2; plural=(n > 1);\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.12.1\n" + +#: ../../planification.rst:3 +msgid "Package Structure" +msgstr "" + +#: ../../planification.rst:5 +msgid "" +"Here is `xhydro`'s structure as of v0.2.2, with the planned or discussed " +"additions for the future." +msgstr "" diff --git a/docs/locales/fr/LC_MESSAGES/readme.po b/docs/locales/fr/LC_MESSAGES/readme.po new file mode 100644 index 00000000..c49bf604 --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/readme.po @@ -0,0 +1,76 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, Thomas-Charles Fortier Filion +# This file is distributed under the same license as the xHydro package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: xHydro 0.3.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-12-08 12:18-0500\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language: fr\n" +"Language-Team: fr \n" +"Plural-Forms: nplurals=2; plural=(n > 1);\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.12.1\n" + +#: ../../../README.rst:3 +msgid "xHydro" +msgstr "" + +#: ../../../README.rst:5 +msgid "|pypi| |build| |docs| |license|" +msgstr "" + +#: ../../../README.rst +msgid "PyPI" +msgstr "" + +#: ../../../README.rst +msgid "Build Status" +msgstr "" + +#: ../../../README.rst +msgid "Documentation Status" +msgstr "" + +#: ../../../README.rst +msgid "License" +msgstr "" + +#: ../../../README.rst:7 +msgid "Hydrological analysis library built with xarray" +msgstr "Bibliothèque d'analyse hydrologique construite avec xarray" + +#: ../../../README.rst:9 +msgid "Free software: Apache-2.0" +msgstr "Logiciel libre : Apache-2.0" + +#: ../../../README.rst:10 +msgid "Documentation: https://xhydro.readthedocs.io." +msgstr "" + +#: ../../../README.rst:13 +msgid "Features" +msgstr "Fonctionnalités" + +#: ../../../README.rst:15 +msgid "TODO" +msgstr "" + +#: ../../../README.rst:18 +msgid "Credits" +msgstr "Crédits" + +#: ../../../README.rst:20 +msgid "" +"This package was created with Cookiecutter_ and the `Ouranosinc" +"/cookiecutter-pypackage`_ project template." +msgstr "" +"Ce paquet a été créé avec Cookiecutter_ et le modèle de projet `Ouranosinc" +"/cookiecutter-pypackage`_." diff --git a/docs/locales/fr/LC_MESSAGES/usage.po b/docs/locales/fr/LC_MESSAGES/usage.po new file mode 100644 index 00000000..0a42f02f --- /dev/null +++ b/docs/locales/fr/LC_MESSAGES/usage.po @@ -0,0 +1,28 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, Thomas-Charles Fortier Filion +# This file is distributed under the same license as the xHydro package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: xHydro 0.3.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-12-08 12:18-0500\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language: fr\n" +"Language-Team: fr \n" +"Plural-Forms: nplurals=2; plural=(n > 1);\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.12.1\n" + +#: ../../usage.rst:3 +msgid "Usage" +msgstr "" + +#: ../../usage.rst:5 +msgid "To use xHydro in a project::" +msgstr "" diff --git a/environment-dev.yml b/environment-dev.yml index 1cb530d4..60487057 100644 --- a/environment-dev.yml +++ b/environment-dev.yml @@ -31,6 +31,7 @@ dependencies: - sphinx-autoapi - sphinx-codeautolink - sphinx-copybutton + - sphinx-intl - sphinxcontrib-napoleon # Testing - tox >=4.0 diff --git a/pyproject.toml b/pyproject.toml index 059c9f12..7cf14e46 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -77,6 +77,7 @@ docs = [ "sphinx-autoapi", "sphinx-codeautolink", "sphinx-copybutton", + "sphinx-intl", "sphinxcontrib-napoleon" ]