Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Public documentation - first stable version #18

Merged
merged 14 commits into from
Mar 20, 2024

Conversation

chucheria
Copy link
Collaborator

@chucheria chucheria commented Mar 8, 2024

Use Sphinx with autodoc to automatically create documentation.

Public documentation only includes high-level classes, those designed as tasks or models.

The Makefile has been modified to include the install to modify docs and to build the html. The built has to be uploaded to the repository with the docs, no action to do this automatically has been added due to lack of permissions.

  • make docs will setup and install all needed for writing docs.
  • make html calls sphinx Makefile to build the HTML.

@nimbusaeta
Copy link
Collaborator

Looks good! As discussed, I added 2 commits to fix the problems we saw.

@nimbusaeta
Copy link
Collaborator

I added some commits editing the texts to include the last edition to the readme file.

@nimbusaeta
Copy link
Collaborator

The last 2 commits have been added to show Classes in the main page and the navigation bar.

@chucheria chucheria merged commit fdb936f into main Mar 20, 2024
10 checks passed
@chucheria chucheria deleted the feature/build-documentation branch March 20, 2024 12:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants