From 1b8a2f898d44f5a107b9ce191eecbd880750f757 Mon Sep 17 00:00:00 2001 From: DBees Date: Thu, 25 Jan 2024 09:34:41 -0800 Subject: [PATCH] Updating readthedocs yaml file to specify build os --- .readthedocs.yaml | 18 ++++++---- docs/conf.py | 76 +++++++++++++++++++++++++++++++++++++++++++ docs/source/index.rst | 2 +- 3 files changed, 88 insertions(+), 8 deletions(-) create mode 100644 docs/conf.py diff --git a/.readthedocs.yaml b/.readthedocs.yaml index b8eebed59..ffcc08faf 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,4 +1,4 @@ -# Copyright 2020 OpenHW Group +# Copyright 2023 OpenHW Group # Solderpad Hardware License, Version 2.1, see LICENSE.md for details. # SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1 @@ -8,12 +8,16 @@ # Required version: 2 -# Build documentation in the docs/ directory with Sphinx +build: + os: "ubuntu-20.04" + tools: + python: "3.9" + +# Build from the docs directory with Sphinx sphinx: - configuration: docs/conf.py + configuration: docs/conf.py -# Optionally set the version of Python and requirements required to build your docs +# Explicitly set the Python requirements python: - version: 3.8 - install: - - requirements: docs/requirements.txt + install: + - requirements: docs/requirements.txt diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..dac2e79aa --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,76 @@ +# Copyright 2022 OpenHW Group +# Solderpad Hardware License, Version 2.1, see LICENSE.md for details. +# SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1 + +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'CORE-V-CORES' +copyright = '2024-present, OpenHW Group' +author = 'OpenHW Group Contributors' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'recommonmark', + 'sphinx_markdown_tables', +] +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'README.md'] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = {'style_nav_header_background': '#DDDDDD'} +html_logo = '_static/openhw-landscape.svg' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +#html_static_path = ['ystatic'] +# Set html_static_path to null on the advice of RTDs: +html_static_path = [] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} diff --git a/docs/source/index.rst b/docs/source/index.rst index 006bc5f34..fcdb50ebb 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -7,7 +7,7 @@ CORE-V Documentation .. meta:: :description lang=en: continuous CORE-V documentation development on Read the Docs. -.. image:: images/CORE-V-landscape.png +.. image:: ../images/CORE-V-landscape.png `CORE-V Docs` is the top level Read the Docs project for OpenHW Group's CORE-V family of open-source RISC-V processor cores and related projects.