Skip to content

Commit

Permalink
Add MD files in /Documentation to the Sphinx TOC
Browse files Browse the repository at this point in the history
Co-authored-by: NicoHambauer <nico.hambauer@fau.de>
Signed-off-by: Tims777 <git@tisizi.de>
  • Loading branch information
Tims777 and NicoHambauer committed Feb 14, 2024
1 parent 229993b commit 6b4d559
Show file tree
Hide file tree
Showing 4 changed files with 85 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ bin/
!**/docs/make.bat
!**/docs/Makefile
!**/docs/readme_link.md
!**/docs/documentation.rst

# Env files
*.env
Expand Down
4 changes: 2 additions & 2 deletions Documentation/data-fields.csv
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Phone,string,Phone number of the lead,Lead data,-,49 1234 56789
Email,string,Email of the lead,Lead data,-,musteremail@example.com
domain,string,"The domain of the email is the part that follows the ""@"" symbol, indicating the organization or service hosting the email address.",processing,Email,example.com
email_valid,boolean,Checks if the email is valid.,email_validator package,Email,True/False
first_name_in_account,boolean,Checks if first name is written in "Account" input,processing,First Name,True/False
last_name_in_account,boolean,Checks if last name is written in "Account" input,processing,Last Name,True/False
first_name_in_account,boolean,"Checks if first name is written in ""Account"" input",processing,First Name,True/False
last_name_in_account,boolean,"Checks if last name is written in ""Account"" input",processing,Last Name,True/False
number_formatted,string,Phone number (formatted),phonenumbers package,Phone,49123456789
number_country,string,Country derived from phone number,phonenumbers package,Phone,Germany
number_area,string,Area derived from phone number,phonenumbers package,Phone,Erlangen
Expand Down
81 changes: 81 additions & 0 deletions src/docs/documentation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
.. SPDX-License-Identifier: MIT
.. SPDX-FileCopyrightText: 2024 Simon Zimmermann <tim.simon.zimmermann@fau.de>
Build Documentation
===================
.. include:: ../../Documentation/Build-Documentation.md
:parser: myst_parser.sphinx_

User Documentation
==================
.. include:: ../../Documentation/User-Documentation.md
:parser: myst_parser.sphinx_

Design Documentation
====================
.. include:: ../../Documentation/Design-Documentation.md
:parser: myst_parser.sphinx_

Data Fields
-----------
.. include:: ../../Documentation/Data-Fields.md
:parser: myst_parser.sphinx_

.. _\./data-fields\.csv:

Data Fields CSV
---------------------

The following table highlights the data fields obtained for each lead.
The acquisition of such data may derive from the Lead Form or may be extracted from external sources utilizing APIs.

.. csv-table:: Data Field Definition
:file: ../../Documentation/data-fields.csv
:header-rows: 1
:widths: auto

Google Search Strategy
----------------------
.. include:: ../../Documentation/Google-Search-Strategy.md
:parser: myst_parser.sphinx_

OpenLLM Business Type Analysis
------------------------------
.. include:: ../../Documentation/OpenLLm-Business-Type-Analysis.md
:parser: myst_parser.sphinx_

Classifier Comparison
=====================
.. include:: ../../Documentation/Classifier-Comparison.md
:parser: myst_parser.sphinx_

Concepts, Unrealized Ideas & Miscellaneous
==========================================

.. include:: ../../Documentation/ideas.md
:parser: myst_parser.sphinx_

Controller
----------
.. include:: ../../Documentation/Controller.md
:parser: myst_parser.sphinx_

Twitter API Limitation
----------------------
.. include:: ../../Documentation/Twitter-API-Limitation.md
:parser: myst_parser.sphinx_

Contribution
------------
.. include:: ../../Documentation/Contribution.md
:parser: myst_parser.sphinx_

SBOM Generator
--------------
.. include:: ../../Documentation/SBOM_generator.md
:parser: myst_parser.sphinx_

Miscellaneous
-------------
.. include:: ../../Documentation/Miscellaneous.md
:parser: myst_parser.sphinx_
1 change: 1 addition & 0 deletions src/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Welcome to Sales Lead Qualifier's documentation!
:caption: Contents:

readme_link
documentation
modules

Indices and tables
Expand Down

0 comments on commit 6b4d559

Please sign in to comment.