create docs #1
Open
create docs #1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request includes significant updates to the documentation and the addition of new reference materials for the
pythaidatelibrary. The most important changes include restructuring theREADME.md, adding new documentation files, and updating existing content for clarity and completeness.Documentation improvements:
README.md: Reorganized sections, added detailed instructions for building and serving documentation locally, and improved formatting for better readability. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]docs/index.md: Created an index file introducing thepythaidatelibrary and providing installation instructions.New documentation files:
docs/about/license.md: Added a file detailing the MIT License under which the project is licensed.docs/about/references.md: Added a file listing references and resources related to Thai calendar systems.docs/api/csdate.md: Added an API reference for theCsDateclass, detailing its constructors, properties, methods, and supported operations.docs/api/helpers.md: Added an API reference for helper functions related to Julian Day Number conversions and Thai number conversions.docs/api/pakdate.md: Added an API reference for thePakDateclass, detailing its constructors, properties, methods, and supported operations.docs/user-guide/csdate.md: Added a user guide for theCsDateclass, including examples of basic usage, calendar properties, alternative constructors, formatting, and intercalations.