Skip to content

Commit 819f071

Browse files
PeriniMPeriniM
committed
docs(burr): added dependecies and switched to furo
1 parent ac10128 commit 819f071

14 files changed

+545
-126
lines changed

‎docs/source/conf.py‎

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -23,27 +23,17 @@
2323
# -- General configuration ---------------------------------------------------
2424
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
2525

26-
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon','sphinx_wagtail_theme']
26+
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']
2727

2828
templates_path = ['_templates']
2929
exclude_patterns = []
3030

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

34-
# html_theme = 'sphinx_rtd_theme'
35-
html_theme = 'sphinx_wagtail_theme'
36-
37-
html_theme_options = dict(
38-
project_name = "ScrapeGraphAI",
39-
logo = "scrapegraphai_logo.png",
40-
logo_alt = "ScrapeGraphAI",
41-
logo_height = 59,
42-
logo_url = "https://scrapegraph-ai.readthedocs.io/en/latest/",
43-
logo_width = 45,
44-
github_url = "https://github.com/VinciGit00/Scrapegraph-ai/tree/main/docs/source/",
45-
footer_links = ",".join(
46-
["Landing Page|https://scrapegraphai.com/",
47-
"Docusaurus|https://scrapegraph-doc.onrender.com/docs/intro"]
48-
),
49-
)
34+
html_theme = 'furo'
35+
html_theme_options = {
36+
"source_repository": "https://github.com/VinciGit00/Scrapegraph-ai/",
37+
"source_branch": "main",
38+
"source_directory": "docs/source/",
39+
}

‎docs/source/modules/modules.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
scrapegraphai
2+
=============
3+
14
.. toctree::
25
:maxdepth: 4
36

‎docs/source/modules/scrapegraphai.builders.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
scrapegraphai.builders package
2+
==============================
3+
4+
Submodules
5+
----------
6+
7+
scrapegraphai.builders.graph\_builder module
8+
--------------------------------------------
9+
10+
.. automodule:: scrapegraphai.builders.graph_builder
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: scrapegraphai.builders
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎docs/source/modules/scrapegraphai.docloaders.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
scrapegraphai.docloaders package
2+
================================
3+
4+
Submodules
5+
----------
6+
7+
scrapegraphai.docloaders.chromium module
8+
----------------------------------------
9+
10+
.. automodule:: scrapegraphai.docloaders.chromium
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: scrapegraphai.docloaders
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎docs/source/modules/scrapegraphai.graphs.rst‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ scrapegraphai.graphs package
44
Submodules
55
----------
66

7+
scrapegraphai.graphs.abstract\_graph module
8+
-------------------------------------------
9+
10+
.. automodule:: scrapegraphai.graphs.abstract_graph
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
715
scrapegraphai.graphs.base\_graph module
816
---------------------------------------
917

@@ -12,6 +20,70 @@ scrapegraphai.graphs.base\_graph module
1220
:undoc-members:
1321
:show-inheritance:
1422

23+
scrapegraphai.graphs.csv\_scraper\_graph module
24+
-----------------------------------------------
25+
26+
.. automodule:: scrapegraphai.graphs.csv_scraper_graph
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
scrapegraphai.graphs.deep\_scraper\_graph module
32+
------------------------------------------------
33+
34+
.. automodule:: scrapegraphai.graphs.deep_scraper_graph
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
scrapegraphai.graphs.json\_scraper\_graph module
40+
------------------------------------------------
41+
42+
.. automodule:: scrapegraphai.graphs.json_scraper_graph
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
scrapegraphai.graphs.omni\_scraper\_graph module
48+
------------------------------------------------
49+
50+
.. automodule:: scrapegraphai.graphs.omni_scraper_graph
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
scrapegraphai.graphs.omni\_search\_graph module
56+
-----------------------------------------------
57+
58+
.. automodule:: scrapegraphai.graphs.omni_search_graph
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
scrapegraphai.graphs.pdf\_scraper\_graph module
64+
-----------------------------------------------
65+
66+
.. automodule:: scrapegraphai.graphs.pdf_scraper_graph
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
scrapegraphai.graphs.script\_creator\_graph module
72+
--------------------------------------------------
73+
74+
.. automodule:: scrapegraphai.graphs.script_creator_graph
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
79+
scrapegraphai.graphs.search\_graph module
80+
-----------------------------------------
81+
82+
.. automodule:: scrapegraphai.graphs.search_graph
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:
86+
1587
scrapegraphai.graphs.smart\_scraper\_graph module
1688
-------------------------------------------------
1789

@@ -20,6 +92,38 @@ scrapegraphai.graphs.smart\_scraper\_graph module
2092
:undoc-members:
2193
:show-inheritance:
2294

95+
scrapegraphai.graphs.smart\_scraper\_graph\_burr module
96+
-------------------------------------------------------
97+
98+
.. automodule:: scrapegraphai.graphs.smart_scraper_graph_burr
99+
:members:
100+
:undoc-members:
101+
:show-inheritance:
102+
103+
scrapegraphai.graphs.smart\_scraper\_graph\_hamilton module
104+
-----------------------------------------------------------
105+
106+
.. automodule:: scrapegraphai.graphs.smart_scraper_graph_hamilton
107+
:members:
108+
:undoc-members:
109+
:show-inheritance:
110+
111+
scrapegraphai.graphs.speech\_graph module
112+
-----------------------------------------
113+
114+
.. automodule:: scrapegraphai.graphs.speech_graph
115+
:members:
116+
:undoc-members:
117+
:show-inheritance:
118+
119+
scrapegraphai.graphs.xml\_scraper\_graph module
120+
-----------------------------------------------
121+
122+
.. automodule:: scrapegraphai.graphs.xml_scraper_graph
123+
:members:
124+
:undoc-members:
125+
:show-inheritance:
126+
23127
Module contents
24128
---------------
25129

‎docs/source/modules/scrapegraphai.helpers.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
scrapegraphai.helpers package
2+
=============================
3+
4+
Submodules
5+
----------
6+
7+
scrapegraphai.helpers.models\_tokens module
8+
-------------------------------------------
9+
10+
.. automodule:: scrapegraphai.helpers.models_tokens
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
scrapegraphai.helpers.nodes\_metadata module
16+
--------------------------------------------
17+
18+
.. automodule:: scrapegraphai.helpers.nodes_metadata
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
scrapegraphai.helpers.robots module
24+
-----------------------------------
25+
26+
.. automodule:: scrapegraphai.helpers.robots
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
scrapegraphai.helpers.schemas module
32+
------------------------------------
33+
34+
.. automodule:: scrapegraphai.helpers.schemas
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
Module contents
40+
---------------
41+
42+
.. automodule:: scrapegraphai.helpers
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:

‎docs/source/modules/scrapegraphai.integrations.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
scrapegraphai.integrations package
2+
==================================
3+
4+
Submodules
5+
----------
6+
7+
scrapegraphai.integrations.burr\_bridge module
8+
----------------------------------------------
9+
10+
.. automodule:: scrapegraphai.integrations.burr_bridge
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: scrapegraphai.integrations
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎docs/source/modules/scrapegraphai.models.rst‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
scrapegraphai.models package
2+
============================
3+
4+
Submodules
5+
----------
6+
7+
scrapegraphai.models.anthropic module
8+
-------------------------------------
9+
10+
.. automodule:: scrapegraphai.models.anthropic
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
scrapegraphai.models.azure\_openai module
16+
-----------------------------------------
17+
18+
.. automodule:: scrapegraphai.models.azure_openai
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
scrapegraphai.models.bedrock module
24+
-----------------------------------
25+
26+
.. automodule:: scrapegraphai.models.bedrock
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
scrapegraphai.models.deepseek module
32+
------------------------------------
33+
34+
.. automodule:: scrapegraphai.models.deepseek
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
scrapegraphai.models.gemini module
40+
----------------------------------
41+
42+
.. automodule:: scrapegraphai.models.gemini
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
scrapegraphai.models.groq module
48+
--------------------------------
49+
50+
.. automodule:: scrapegraphai.models.groq
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
scrapegraphai.models.hugging\_face module
56+
-----------------------------------------
57+
58+
.. automodule:: scrapegraphai.models.hugging_face
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
scrapegraphai.models.ollama module
64+
----------------------------------
65+
66+
.. automodule:: scrapegraphai.models.ollama
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
scrapegraphai.models.openai module
72+
----------------------------------
73+
74+
.. automodule:: scrapegraphai.models.openai
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
79+
scrapegraphai.models.openai\_itt module
80+
---------------------------------------
81+
82+
.. automodule:: scrapegraphai.models.openai_itt
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:
86+
87+
scrapegraphai.models.openai\_tts module
88+
---------------------------------------
89+
90+
.. automodule:: scrapegraphai.models.openai_tts
91+
:members:
92+
:undoc-members:
93+
:show-inheritance:
94+
95+
Module contents
96+
---------------
97+
98+
.. automodule:: scrapegraphai.models
99+
:members:
100+
:undoc-members:
101+
:show-inheritance:

0 commit comments

Comments
 (0)