[DOC] Generate Sphinx

[ArthurFerreiraRodrigues]

Description:

GitHub pages made with sphinx.

Tasks:

Checklist of tasks that must be performed.

• Create GitHub pages with sphinx.
• Put the docs on GitHub Pages.

Acceptance criteria:

• Done the tasks defined in the issue
• Have the gitHub pages link of the project

[ArthurFerreiraRodrigues]

Description the bug

An error was encountered opening the github pages link.

The page had no styling, it looks like this error is because github pages are unable to read the files correctly.

Expected behavior

What was expected was that the github pages link was styled and with correct accesses.

[Madu01]

The fix for the bug

The fix for this bug was the addition of the .nojekyll file, this file is empty but it helped the github pages to read the files correctly.

--> for more information about this .nojekyll file, go to Jekyll!

[Madu01]

Description:

Put the files in .md in the sphinx document.

Tasks:

Checklist of tasks that must be performed.

• configure sphinx to accept .md files.
• comment how to resolve this issue.

Acceptance criteria:

• Done the tasks defined in the issue

[Madu01]

How to use Markdown in sphinx.

for sphinx to accept .md files it was necessary to install a library locally, with the command:

pip install myst-parser

Then in the conf.py file was added:

extensions = ["myst_parser"]

source_suffix = {
    '.rst': 'restructuredtext',
    '.txt': 'markdown',
    '.md': 'markdown',
}

Then I added the markdown files to the project. In index.rst file I added the names of markdown files.

--> for more information see: sphinx-doc-markdown and Using-Markdown-with-Sphinx!