-
Notifications
You must be signed in to change notification settings - Fork 217
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2206 from mithro/rtdfix
Fixing the Read The Docs action
- Loading branch information
Showing
4 changed files
with
70 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,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: | ||
- epub |
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,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'), | ||
] |
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,18 @@ | ||
Using Verible | ||
============= | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
style_lint.md | ||
formatter.md | ||
indexing.md | ||
|
||
Developing Verible | ||
================== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
development.md | ||
parser_design.md |
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 | ||
sphinx-rtd-theme | ||
pillow | ||
mock | ||
myst-parser |