-
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Attempt to get the read-the-docs to pass with empty docs
- Loading branch information
Showing
4 changed files
with
108 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Read the Docs configuration file for Sphinx projects | ||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
||
# Required | ||
version: 2 | ||
|
||
# Set the OS, Python version and other tools you might need | ||
build: | ||
os: ubuntu-22.04 | ||
tools: | ||
python: "3.12" | ||
|
||
# Build documentation in the "docs/" directory with Sphinx | ||
sphinx: | ||
configuration: docs/conf.py | ||
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs | ||
# builder: "dirhtml" | ||
# Fail on all warnings to avoid broken references | ||
# fail_on_warning: true | ||
# Optionally build your docs in additional formats such as PDF and ePub | ||
# formats: | ||
# - epub | ||
|
||
# Optional but recommended, declare the Python requirements required | ||
# to build your documentation | ||
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html | ||
python: | ||
install: | ||
- method: pip | ||
path: . | ||
- requirements: docs/requirements.txt |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
from sphinx_celery import conf | ||
|
||
globals().update( | ||
conf.build_config( | ||
"pytest-celery", | ||
__file__, | ||
project="pytest-celery", | ||
version_dev="1.0.0a1", | ||
version_stable="0.1.0", | ||
canonical_url="https://docs.pytest-celery.dev", # Update with your documentation URL | ||
webdomain="pytest-celery.dev", # Update with your domain | ||
github_project="celery/pytest-celery", | ||
author="Tomer Nosrati", | ||
author_name="Tomer Nosrati", | ||
copyright="2023", | ||
publisher="Celery Project", | ||
# html_logo='images/logo.png', # Update with your logo file if available, uncomment this line when ready | ||
# html_favicon='images/favicon.ico', # Update with your favicon file if available, uncomment this line when ready | ||
html_prepend_sidebars=[], # Update with your sidebar file if any, or remove this line if not needed | ||
extra_extensions=[ | ||
"sphinx_click", | ||
"sphinx.ext.napoleon", | ||
# ... other extensions ... | ||
], | ||
extra_intersphinx_mapping={ | ||
# ... other intersphinx mappings ... | ||
}, | ||
apicheck_ignore_modules=[], | ||
linkcheck_ignore=[r"^http://localhost"], | ||
autodoc_mock_imports=[], # Update with any modules that should be mocked, or remove this line if not needed | ||
) | ||
) | ||
|
||
settings = {} | ||
ignored_settings = { | ||
# Update with any deprecated settings or remove this block if not needed | ||
} | ||
|
||
|
||
def configcheck_project_settings(): | ||
# Update with your project settings or remove this function if not needed | ||
pass | ||
|
||
|
||
def is_deprecated_setting(setting): | ||
# Update with your project settings or remove this function if not needed | ||
pass | ||
|
||
|
||
def configcheck_should_ignore(setting): | ||
return setting in ignored_settings or is_deprecated_setting(setting) |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
.. pytest-celery documentation master file, created by | ||
sphinx-quickstart on Tue Oct 19 13:33:33 2023. | ||
You can adapt this file completely to your liking, but it should at least | ||
contain the root `toctree` directive. | ||
Welcome to pytest-celery's documentation! | ||
========================================== | ||
|
||
Contents: | ||
--------- | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
Indices and tables | ||
================== | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
sphinx_celery>=2.0.0 | ||
Sphinx==5.3.0 | ||
sphinx-testing~=1.0.1 | ||
sphinx-click==4.4.0 | ||
# ... other dependencies ... |