Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test the Sphinx build #21

Open
chucheria opened this issue Mar 21, 2024 · 0 comments
Open

Test the Sphinx build #21

chucheria opened this issue Mar 21, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation minor issue testing

Comments

@chucheria
Copy link
Collaborator

chucheria commented Mar 21, 2024

Description

Test the Sphinx build to capture warnings and ensure a successful build.

Current Behavior

The current Sphinx build trusts the developer to upload a good build.

Desired Behavior

The Sphinx build process should capture all warnings and errors to ensure a successful build.

Motivation

Capturing warnings and errors during the Sphinx build process helps identify potential issues and ensures a high-quality documentation output. This is essential for maintaining a reliable and informative documentation for users.

Additional Context

To test the Sphinx build and capture warnings:

  1. Follow the steps to set up the environment and build the documentation as outlined in the documentation or README.
  2. Monitor the build process for any warnings or errors.
  3. Ensure that the build process completes successfully without any critical issues.
  4. If any warnings or errors are encountered, investigate and address them accordingly to improve the documentation quality.
  • Version: 0.1.1
  • Python Version: 3.8

Possible Implementation

This SO answer could be a starting point.

@chucheria chucheria added documentation Improvements or additions to documentation testing minor issue labels Mar 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation minor issue testing
Projects
None yet
Development

No branches or pull requests

1 participant