Docs #12
Open
Docs #12
Conversation
This file contains 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
akiraonstarknet
requested changes
Nov 4, 2024
| # Default target: Generate HTML documentation with pdoc, ensuring PYTHONPATH is set correctly (Windows compatible) | ||
| docs: | ||
| @echo "Generating documentation with pdoc..." | ||
| @set PYTHONPATH=C:/Users/molak/strategy-research;C:/Users/molak/AppData/Local/pypoetry/Cache/virtualenvs/strategy-research-dv98sU_e-py3.9/lib/python3.9/site-packages && poetry run pdoc --output-dir $(DOCS_DIR) $(SOURCE_DIR) |
There was a problem hiding this comment.
The code is using paths specific to your system.
| # Target to run tests, ensuring pytest runs within the Poetry environment (Windows compatible) | ||
| test: | ||
| @echo "Running tests..." | ||
| @set PYTHONPATH=C:/Users/molak/strategy-research;C:/Users/molak/AppData/Local/pypoetry/Cache/virtualenvs/strategy-research-dv98sU_e-py3.9/lib/python3.9/site-packages && poetry run pytest $(TEST_DIR) |
| @@ -0,0 +1,2 @@ | |||
| # src/__init__.py | |||
There was a problem hiding this comment.
Unnecessary files. Please fix gitignore.
|
@ManvithaMolakala share screenshot of generated docs. |
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.
Generated docs as per issue #8.