From fe0014cbcdac9b7c75ec1d051e260013ce40944b Mon Sep 17 00:00:00 2001 From: Benjamin Bollen Date: Fri, 14 Jun 2024 15:31:15 +0100 Subject: [PATCH] (docs): remove old attempt of building docs --- .gitignore | 3 +++ docs/generate_solidity_docs.sh | 7 ------- docs/requirements.txt | 5 ----- docs/source/conf.py | 27 --------------------------- docs/source/index.rst | 15 --------------- 5 files changed, 3 insertions(+), 54 deletions(-) delete mode 100755 docs/generate_solidity_docs.sh delete mode 100644 docs/requirements.txt delete mode 100644 docs/source/conf.py delete mode 100644 docs/source/index.rst diff --git a/.gitignore b/.gitignore index 052eb5f..852fb69 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,9 @@ cache/ out/ +# docs +docs/ + # gas snapshot files .gas-snapshot diff --git a/docs/generate_solidity_docs.sh b/docs/generate_solidity_docs.sh deleted file mode 100755 index 2fca8f1..0000000 --- a/docs/generate_solidity_docs.sh +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/bash - -# Run solidity-docgen -npx solidity-docgen --output docs/source/solidity --solc-module solc - -# Ensure the output directory exists -mkdir -p docs/source/solidity diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 4112426..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,5 +0,0 @@ -# Defining the exact version will make sure things don't break -sphinx==5.3.0 -sphinx_rtd_theme==1.1.1 -sphinx-autobuild==2024.4.16 -readthedocs-sphinx-search==0.1.1 \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py deleted file mode 100644 index 6b6e98b..0000000 --- a/docs/source/conf.py +++ /dev/null @@ -1,27 +0,0 @@ -# conf.py - -import os -import sys -sys.path.insert(0, os.path.abspath('.')) - -# Project information -project = 'Circles' -author = 'AboutCircles' -release = '0.3.4' - -# General configuration -extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.napoleon', - 'sphinx.ext.viewcode', -] - -templates_path = ['_templates'] -exclude_patterns = [] - -# Options for HTML output -html_theme = 'alabaster' -html_static_path = ['_static'] - -# Add Solidity docgen output path -solidity_docgen_output = os.path.abspath('solidity') diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index a6c7cf6..0000000 --- a/docs/source/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -Welcome to Circles documentation! -================================================= - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - solidity/index - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search`