feat: Add Sphinx documentation for the project#20
Open
joereg4 wants to merge 1 commit intoPokemonTCG:masterfrom
Open
feat: Add Sphinx documentation for the project#20joereg4 wants to merge 1 commit intoPokemonTCG:masterfrom
joereg4 wants to merge 1 commit intoPokemonTCG:masterfrom
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
1 participant
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 introduces a comprehensive documentation site for the
pokemon-tcg-sdk-pythonproject, generated using Sphinx. The official pokemontcg.io website mentioned that documentation was "coming soon," so this aims to fill that gap.Key Features
/docsdirectory.Installationand aGetting Startedtutorial that covers API key configuration and basic usage.sphinx.ext.autodoc.make docscommand has been added to the Makefile, which builds the HTML documentation and opens it in a browser, making it easy to review and maintain.How to Review
make setupto ensure all dependencies are installed.make docsfrom the project root.This will build the documentation and open the main page (
docs/_build/html/index.html) in your default browser.This new documentation should make the SDK much more approachable for new users. Let me know if you have any feedback!