Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@dr-prodigy Not sure why it was so complex to incorporate the commits you made today (sigh) into this branch, but finally here is a PR that can both be merged and that passes all tox tests.
Finally, I had some time to finish the Sphinx/readthedocs.io documentation. There was a lot of work and QA involved in doing it, but I think you will be very pleased with the result. The documentation is now (in my opinion) much more legible and user friendly, and finally the API is 100% documented -- inline, in IDE, and on Read the Docs.
The following changes were needed for the documentation:
CountryHoliday
(now aliased to the more Python-friendlycountry_holidays
) for documentation purposes.ChineseLuniSolar
class andislamic_to_gre
as being private (i.e. renamed to_ChineseLuniSolar
and_islamic_to_gre
), and this in turn required minor edits to a high number of country files.TestTaiwan
for Taiwan (was calledTestTunisia
!) and the ISO 3166-1 alpha-2 country code in thecountry
variable of Bangladesh ("BD" and not "TR"), United Kingdom ("GB" and not "UK") and of ECB/TARGET2 ("ECB" and not "EU"); I know good practice for this to be a separate PR, but got too lazy, so apologies ;)I could not test an actual Read the Docs build, but given that a full document build passes the tox test, I have high confidence that it will build without a problem (typos and all).
Incidentally, one of the many good things about building the documentation on Sphinx/readthedocs.io is that we finally have a way to publish individual country pages (with e.g. information such as that country's subdivisions, sources of data, why certain holidays are included and others aren't, etc. etc.), which will be very useful as the project continues to grow.
Edits are obviously welcomed; you're the maintainer!