Skip to content

Commit

Permalink
Deprecate readthedocs site (#1341)
Browse files Browse the repository at this point in the history
* Add .readthedocs.yaml

* deprecate site

* ...

* update version

---------

Co-authored-by: Stuart Popejoy <[email protected]>
  • Loading branch information
sirlensalot and sirlensalot authored Feb 17, 2024
1 parent 31b2b6a commit 397ebc9
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 3 deletions.
35 changes: 35 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# 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"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/en/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:
# - requirements: docs/requirements.txt
4 changes: 2 additions & 2 deletions docs/en/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@
# built documents.
#
# The short X.Y version.
version = u'4.8'
version = u'4.10'
# The full version, including alpha/beta/rc tags.
release = u'4.8.0'
release = u'4.10.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
4 changes: 3 additions & 1 deletion docs/en/pact-reference.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
.. image:: img/kadena-logo-210px.png

Pact Smart Contract Language Reference
DEPRECATED Pact Smart Contract Language Reference
======================================

**This document is no longer maintained, please use `the official Pact Reference site <https://docs.kadena.io/pact/reference>`__ **
This document is a reference for the Pact smart-contract language,
designed for correct, transactional execution on a `high-performance
blockchain <http://kadena.io>`__. For more background, please see the
Expand Down

0 comments on commit 397ebc9

Please sign in to comment.