readthedocs #229
Merged
readthedocs #229
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
![bartholomew-smith[bot]](https://avatars.githubusercontent.com/in/792560?s=60&v=4){kind=small}
In this commit, the README.md file has been deleted and replaced by a README.rst file. This change enables a better integration with various Python document processing tools and is more universally accepted in Python projects.
|
Here's the code health analysis summary for commits Analysis Summary
Code Coverage Report
|
The display of various badges was reorganized for better readability. The description of the 'GitHub commits since latest release' badge was also simplified for a more concise description.
An extra line break, which was previously causing a formatting issue in the README.rst file, has been removed. The document structure and format are now consistent.
This commit introduces a configuration for the Sphinx documentation builder with the `conf.py` setup file. It adds an `index.rst` file for documentation content and automation files (`make.bat` and `Makefile`) to build the documentation.
This commit introduces a configuration for the Sphinx documentation builder with the `conf.py` setup file. It adds an `index.rst` file for documentation content and automation files (`make.bat` and `Makefile`) to build the documentation.
A new dependency, `requests_mock`, has been added to the `requirements.txt` file. Also, a typo in the filename of the requirements file located in the docs directory was corrected. It was previously named `requirments.txt` and has now been renamed to `requirements.txt`.
The documentation files `index.rst` and `README.rst` have been deleted and replaced by their Markdown equivalents `index.md` and `README.md`. The conversion was performed to improve readability and consistency, particularly in regard to the handling of links and images.
The documentation files `index.rst` and `README.rst` have been deleted and replaced by their Markdown equivalents `index.md` and `README.md`. The conversion was performed to improve readability and consistency, particularly in regard to the handling of links and images.
The Sphinx extensions have been updated in the documentation requirements and configuration section of the docs. "sphinx-autodoc2" has been added to the requirements while "sphinx.ext.autodoc" has been enabled in the configuration. Additionally, Python version used for building has been downgraded from 3.12 to 3.9.
In the configuration file, the release number is commented out and in the markdown file, the autoclass path is corrected for Sphinx to generate the project documentation accurately.
In this commit, the github-app-handler module has been added to the requirements.txt document. This is necessary to handle the integration of the GitHub application and the requirements file ensures all required modules are installed for the application to function properly.
|
closes #201 |
Modified docs/conf.py to replace sphinx-autodoc2 with autodoc2 and set the appropriate configurations, and changed the html theme. Also updated docs/index.md to use autodoc2-object and amended the reference link.
|
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.
Pull Request automatically created