creanero / stellar_matchmaker

MIT License
1 stars 1 forks source link

Fix documentation approach #31

Open creanero opened 3 months ago

creanero commented 3 months ago

Current method for generating readthedocs and HTML documentation is an anti-pattern. We need to fix the underlying source of the issue which appears to be to do with the import statements in stellar_matchmaker.py

Current documentation commands Comment the import statements in stellar_matchmaker.py python -m twine upload dist/* Uncomment the import statements in stellar_matchmaker.py

Preferred documentation command python -m twine upload dist/*

Suggested fix Resolve the ambiguity in the import statements in stellar_matchmaker.py Refactor stellar_matchmaker.py to be a true module pattern, rather than midway between script and module core Write debug script based on run_python.py which work as a standalone.

creanero commented 2 months ago

Will be fixed after refactor to class.