Merge pull request #2206 from mithro/rtdfix

Fixing the Read The Docs action

Author: hzeller

.readthedocs.yaml

@@ -0,0 +1,23 @@
+# 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:
+
+python:
+  install:
+    - requirements: doc/requirements.txt
+
+formats:
+  - pdf
+  - epub

doc/conf.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+
+from datetime import datetime
+
+extensions = ['myst_parser']
+templates_path = ['templates', '_templates', '.templates']
+source_suffix = ['.rst', '.md']
+source_parsers = {
+      '.rst': 'restructuredtext',
+      '.md': 'markdown',
+}
+master_doc = 'index'
+project = u'verible'
+copyright = str(datetime.now().year)
+version = 'latest'
+release = 'latest'
+exclude_patterns = ['_build']
+pygments_style = 'sphinx'
+htmlhelp_basename = 'verible'
+html_theme = 'sphinx_rtd_theme'
+file_insertion_enabled = False
+latex_documents = [
+  ('index', 'verible.tex', u'verible Documentation', u'', 'manual'),
+]

doc/index.rst

@@ -0,0 +1,18 @@
+Using Verible
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   style_lint.md
+   formatter.md
+   indexing.md
+
+Developing Verible
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   development.md
+   parser_design.md

doc/requirements.txt

@@ -0,0 +1,5 @@
+sphinx
+sphinx-rtd-theme
+pillow
+mock
+myst-parser