Skip to content

Commit

Permalink
Attempt to get the read-the-docs to pass with empty docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Nusnus committed Oct 19, 2023
1 parent f6cd689 commit d231fbf
Show file tree
Hide file tree
Showing 4 changed files with 108 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .readthedocs.yaml
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:
# - pdf
# - 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
51 changes: 51 additions & 0 deletions docs/conf.py
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',
# html_favicon='images/favicon.ico',
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)
20 changes: 20 additions & 0 deletions docs/index.rst
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`
5 changes: 5 additions & 0 deletions docs/requirements.txt
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
libmemcached-dev

0 comments on commit d231fbf

Please sign in to comment.