docs: Remove the sphinx setup
This commit is contained in:
parent
6919c02ada
commit
cd1c675b51
|
@ -1,78 +0,0 @@
|
||||||
# Serene Programming Language
|
|
||||||
#
|
|
||||||
# Copyright (c) 2019-2023 Sameer Rahmani <lxsameer@gnu.org>
|
|
||||||
#
|
|
||||||
# This program is free software; you can redistribute it and/or modify
|
|
||||||
# it under the terms of the GNU General Public License as published by
|
|
||||||
# the Free Software Foundation, version 2.
|
|
||||||
#
|
|
||||||
# This program is distributed in the hope that it will be useful,
|
|
||||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
# GNU General Public License for more details.
|
|
||||||
#
|
|
||||||
# You should have received a copy of the GNU General Public License
|
|
||||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
find_package(Doxygen REQUIRED)
|
|
||||||
find_package(Sphinx REQUIRED)
|
|
||||||
|
|
||||||
# Find all the public headers
|
|
||||||
get_target_property(SERENE_PUBLIC_HEADER_DIR serene INTERFACE_INCLUDE_DIRECTORIES)
|
|
||||||
|
|
||||||
#file(GLOB_RECURSE SERENE_PUBLIC_HEADER_DIR ${SERENE_PUBLIC_HEADER_DIR}/*.h)
|
|
||||||
file(GLOB_RECURSE SERENE_PUBLIC_HEADERS ${INCLUDE_DIR}/*.h)
|
|
||||||
|
|
||||||
set(DOXYGEN_INPUT_DIR ${PROJECT_SOURCE_DIR}/)
|
|
||||||
set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doxygen)
|
|
||||||
set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/html/index.html)
|
|
||||||
set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
|
|
||||||
set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
|
|
||||||
|
|
||||||
# Replace variables inside @@ with the current values
|
|
||||||
configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
|
|
||||||
|
|
||||||
# Doxygen won't create this for us
|
|
||||||
file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR})
|
|
||||||
|
|
||||||
add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE}
|
|
||||||
DEPENDS ${SERENE_PUBLIC_HEADERS}
|
|
||||||
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT}
|
|
||||||
MAIN_DEPENDENCY ${DOXYFILE_OUT} ${DOXYFILE_IN}
|
|
||||||
COMMENT "Generating docs"
|
|
||||||
VERBATIM)
|
|
||||||
|
|
||||||
# Nice named target so we can run the job easily
|
|
||||||
add_custom_target(Doxygen ALL DEPENDS ${DOXYGEN_INDEX_FILE})
|
|
||||||
|
|
||||||
set(SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR})
|
|
||||||
set(SPHINX_BUILD ${CMAKE_CURRENT_BINARY_DIR}/sphinx)
|
|
||||||
set(SPHINX_INDEX_FILE ${SPHINX_BUILD}/index.html)
|
|
||||||
|
|
||||||
# Only regenerate Sphinx when:
|
|
||||||
# - Doxygen has rerun
|
|
||||||
# - Our doc files have been updated
|
|
||||||
# - The Sphinx config has been updated
|
|
||||||
add_custom_command(OUTPUT ${SPHINX_INDEX_FILE}
|
|
||||||
COMMAND
|
|
||||||
${SPHINX_EXECUTABLE} -b html
|
|
||||||
# Tell Breathe where to find the Doxygen output
|
|
||||||
-Dbreathe_projects.Serene=${DOXYGEN_OUTPUT_DIR}/xml
|
|
||||||
${SPHINX_SOURCE} ${SPHINX_BUILD}
|
|
||||||
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
||||||
DEPENDS
|
|
||||||
# Other docs files you want to track should go here (or in some variable)
|
|
||||||
${CMAKE_CURRENT_SOURCE_DIR}/index.rst
|
|
||||||
${DOXYGEN_INDEX_FILE}
|
|
||||||
MAIN_DEPENDENCY ${SPHINX_SOURCE}/conf.py
|
|
||||||
COMMENT "Generating documentation with Sphinx")
|
|
||||||
|
|
||||||
# Nice named target so we can run the job easily
|
|
||||||
add_custom_target(Sphinx ALL DEPENDS ${SPHINX_INDEX_FILE})
|
|
||||||
|
|
||||||
# Add an install target to install the docs
|
|
||||||
include(GNUInstallDirs)
|
|
||||||
install(DIRECTORY ${SPHINX_BUILD}
|
|
||||||
DESTINATION ${CMAKE_INSTALL_DOCDIR})
|
|
||||||
|
|
||||||
add_dependencies(serene Doxygen Sphinx)
|
|
2618
docs/Doxyfile.in
2618
docs/Doxyfile.in
File diff suppressed because it is too large
Load Diff
59
docs/conf.py
59
docs/conf.py
|
@ -1,59 +0,0 @@
|
||||||
# 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 = 'Serene'
|
|
||||||
copyright = '2019-2023, Sameer Rahmani'
|
|
||||||
author = 'Sameer Rahmani'
|
|
||||||
|
|
||||||
# The full version, including alpha/beta/rc tags
|
|
||||||
release = '0.1.0'
|
|
||||||
|
|
||||||
|
|
||||||
# -- 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 = [
|
|
||||||
"breathe"
|
|
||||||
]
|
|
||||||
|
|
||||||
# Breathe Configuration
|
|
||||||
breathe_default_project = "Serene"
|
|
||||||
|
|
||||||
# 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']
|
|
||||||
|
|
||||||
|
|
||||||
# -- 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'
|
|
||||||
|
|
||||||
# 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']
|
|
|
@ -1,24 +0,0 @@
|
||||||
.. Serene documentation master file, created by
|
|
||||||
sphinx-quickstart on Sat Feb 12 22:26:32 2022.
|
|
||||||
You can adapt this file completely to your liking, but it should at least
|
|
||||||
contain the root `toctree` directive.
|
|
||||||
|
|
||||||
Welcome to Serene's documentation!
|
|
||||||
==================================
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
:caption: Contents:
|
|
||||||
|
|
||||||
Docs
|
|
||||||
====
|
|
||||||
|
|
||||||
.. autodoxygenindex::
|
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
|
||||||
==================
|
|
||||||
|
|
||||||
* :ref:`genindex`
|
|
||||||
* :ref:`modindex`
|
|
||||||
* :ref:`search`
|
|
|
@ -1,35 +0,0 @@
|
||||||
@ECHO OFF
|
|
||||||
|
|
||||||
pushd %~dp0
|
|
||||||
|
|
||||||
REM Command file for Sphinx documentation
|
|
||||||
|
|
||||||
if "%SPHINXBUILD%" == "" (
|
|
||||||
set SPHINXBUILD=sphinx-build
|
|
||||||
)
|
|
||||||
set SOURCEDIR=.
|
|
||||||
set BUILDDIR=_build
|
|
||||||
|
|
||||||
if "%1" == "" goto help
|
|
||||||
|
|
||||||
%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
|
|
||||||
)
|
|
||||||
|
|
||||||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
|
||||||
goto end
|
|
||||||
|
|
||||||
:help
|
|
||||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
|
||||||
|
|
||||||
:end
|
|
||||||
popd
|
|
|
@ -1,2 +1 @@
|
||||||
sphinx_rtd_theme==1.0
|
mkdocs-material
|
||||||
breathe==4.32
|
|
||||||
|
|
Loading…
Reference in New Issue