Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@PhilippvK
PhilippvK committed Apr 26, 2024
1 parent 0111a2c commit 2901ae1
Show file tree
Hide file tree
Showing 6 changed files with 72 additions and 176 deletions.
3 changes: 2 additions & 1 deletion docs/.gitignore
View file
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
_build
_build/
_autosummary/
178 changes: 20 additions & 158 deletions docs/conf.py
View file
Original file line number Diff line number Diff line change
@@ -1,169 +1,31 @@
#!/usr/bin/env python
#
# Copyright (c) 2024 TUM Department of Electrical and Computer Engineering.
#
# This file is part of Seal5.
# See https://github.com/tum-ei-eda/seal5.git for further info.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# 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 -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

# pylint: disable=wrong-import-position
import seal5.version # noqa: E402
project = 'Seal5'
copyright = '2024, TUM Department of Electrical and Computer Engineering - Chair of Electronic Design Automation'
author = 'TUM Department of Electrical and Computer Engineering - Chair of Electronic Design Automation'
release = 'v0.1.0'

# -- General configuration ---------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#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 = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "myst_parser", "numpydoc", "sphinxemoji.sphinxemoji"]
extensions = ["sphinx.ext.autodoc", "sphinx.ext.autosummary", "sphinx.ext.viewcode", "myst_parser", "numpydoc", "sphinxemoji.sphinxemoji"]

Check failure on line 17 in docs/conf.py

View workflow job for this annotation

GitHub Actions / Flake8

docs/conf.py#L17 

Line too long (138 > 120 characters) (E501)
numpydoc_show_class_members = False
autosummary_generate = True # Turn on sphinx.ext.autosummary

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ".rst"

# The master toctree document.
master_doc = "index"

# General information about the project.
project = "ML on MCU"
copyright = "2021, TUM Department of Electrical and Computer Engineering - Chair of Electronic Design Automation"
author = "TUM Department of Electrical and Computer Engineering - Chair of Electronic Design Automation"

# The version info for the project you're documenting, acts as replacement
# for |version| and |release|, also used in various other places throughout
# the built documents.
#
# The short X.Y version.
version = seal5.version.__version__
# The full version, including alpha/beta/rc tags.
release = seal5.version.__version__

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False


# -- 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 = 'alabaster'
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 = {}

# 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 = ["_static"]


# -- Options for HTMLHelp output ---------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = "seal5doc"


# -- Options for LaTeX output ------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto, manual, or own class]).
latex_documents = [
(
master_doc,
"seal5.tex",
"Seal5 Documentation",
"TUM Department of Electrical and Computer Engineering - Chair of Electronic Design Automation",
"manual",
),
]


# -- Options for manual page output ------------------------------------
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [(master_doc, "seal5", "Seal5 Documentation", [author], 1)]
root_doc = 'index'


# -- Options for Texinfo output ----------------------------------------
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(
master_doc,
"seal5",
"Seal5 Documentation",
author,
"seal5",
"One line description of project.",
"Miscellaneous",
),
]
html_theme = 'alabaster'
html_static_path = ['_static']
7 changes: 0 additions & 7 deletions docs/docs.rst
View file

This file was deleted.

18 changes: 15 additions & 3 deletions docs/index.rst
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,27 @@
Seal5 documentation
===================
.. Seal5 documentation master file, created by
sphinx-quickstart on Fri Apr 26 15:11:01 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Seal5's documentation!
=================================

.. autosummary::
:toctree: _autosummary
:recursive:

seal5

.. toctree::
:maxdepth: 2
:caption: Contents:

readme
docs


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
35 changes: 35 additions & 0 deletions docs/make.bat
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.https://www.sphinx-doc.org/
exit /b 1
)

if "%1" == "" goto help

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

:end
popd
7 changes: 0 additions & 7 deletions docs/modules.rst
View file

This file was deleted.

0 comments on commit 2901ae1

Please sign in to comment.