Skip to content

Commit

Permalink
Merge branch 'main' of github.com:Kozea/pyphen
Browse files Browse the repository at this point in the history
  • Loading branch information
liZe committed Jan 20, 2025
2 parents b604bcf + b4e91e4 commit 44eef77
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 16 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ hyphenation dictionaries.

This module is a fork of python-hyphenator, written by Wilbert Berendsen.

Many dictionaries are included in pyphen, they come from the LibreOffice git
Many dictionaries are included in Pyphen, they come from the LibreOffice git
repository and are distributed under GPL, LGPL and/or MPL. Dictionaries are not
modified in this repository. See the dictionaries and LibreOffice's repository
for more details.
Expand All @@ -26,5 +26,5 @@ CourtBouillon (https://www.courtbouillon.org).
Copyrights are retained by their contributors, no copyright assignment is
required to contribute to Pyphen. Unless explicitly stated otherwise, any
contribution intentionally submitted for inclusion is licensed under
GPL2.0+/LGPL2.1+/MPL1.1, without any additional terms or conditions. For
GPL 2.0+/LGPL 2.1+/MPL 1.1, without any additional terms or conditions. For
full authorship information, see the version control history.
2 changes: 1 addition & 1 deletion docs/common_use_cases.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Common Use Cases
================

pyphen has been created for WeasyPrint and many common use cases can thus be
Pyphen has been created for WeasyPrint and many common use cases can thus be
found in `its repository`_.

.. _its repository: https://github.com/Kozea/WeasyPrint
Expand Down
8 changes: 4 additions & 4 deletions docs/contribute.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Contribute
==========

You want to add some code to pyphen, launch its tests or improve its
You want to add some code to Pyphen, launch its tests or improve its
documentation? Thank you very much! Here are some tips to help you play with
pyphen in good conditions.
Pyphen in good conditions.

The first step is to clone the repository, create a virtual environment and
install pyphen dependencies.
install Pyphen dependencies.

.. code-block:: shell
Expand All @@ -25,7 +25,7 @@ You can then launch Python to test your changes.
Code & Issues
-------------

If you’ve found a bug in pyphen, it’s time to report it, and to fix it if you
If you’ve found a bug in Pyphen, it’s time to report it, and to fix it if you
can!

You can report bugs and feature requests on GitHub_. If you want to add or
Expand Down
15 changes: 11 additions & 4 deletions docs/first_steps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ First Steps
Installation
------------

The easiest way to use pyphen is to install it in a Python `virtual
The easiest way to use Pyphen is to install it in a Python `virtual
environment`_. When your virtual environment is activated, you can then install
pyphen with pip_::
Pyphen with pip_::

pip install pyphen

Expand All @@ -32,14 +32,16 @@ The dictionaries included in LibreOffice are distributed with Pyphen:

* Afrikaans
* Albanian
* Assamese
* Basque
* Belarusian
* Bulgarian
* Catalan
* Croatian
* Czech
* Danish
* Dutch
* English (Great-Britain and United-States)
* English (United Kingdom and United States)
* Esperanto
* Estonian
* French
Expand All @@ -50,15 +52,20 @@ The dictionaries included in LibreOffice are distributed with Pyphen:
* Icelandic
* Indonesian
* Italian
* Kannada
* Lithuanian
* Latvian
* Marathi
* Mongolian
* Norwegian (Bokmål and Nynorsk)
* Oriya
* Polish
* Portuguese (Brazil and Portugal)
* Punjabi
* Romanian
* Russian
* Serbian (cyrillic and latin)
* Sanskrit
* Serbian (Cyrillic and Latin)
* Slovak
* Slovenian
* Spanish
Expand Down
8 changes: 4 additions & 4 deletions docs/going_further.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ Going Further
=============


Why pyphen?
Why Pyphen?
-----------

pyphen has been created to handle hyphenation in WeasyPrint_.
Pyphen has been created to handle hyphenation in WeasyPrint_.

We wanted to provide a simple Python API and to include hyphenation
dictionaries. So we forked the discontinued python-hyphenator module, written
by Wilbert Berendsen, and released pyphen.
by Wilbert Berendsen, and released Pyphen.

.. _WeasyPrint: https://www.courtbouillon.org/weasyprint

Expand All @@ -23,6 +23,6 @@ high-level classes and a small amount of very simple code.
And of course, WeasyPrint is written in Python too, giving an obvious reason
for this choice.

Speed is not pyphen’s main goal. Code simplicity, maintainability and
Speed is not Pyphen’s main goal. Code simplicity, maintainability and
flexibility are more important goals for this library, as they give the ability
to stay really close to the specification and to fix bugs easily.
2 changes: 1 addition & 1 deletion docs/support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ add new features, fix bugs, and improve documentation.
.. _donations and sponsorship: https://opencollective.com/courtbouillon


Professionnal Support
Professional Support
---------------------

You can improve your experience with CourtBouillon’s tools thanks to our
Expand Down
File renamed without changes.

0 comments on commit 44eef77

Please sign in to comment.