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.

Sign up for GitHub

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

Jump to bottom

feat(doc) Add doc generation with sphinx #19

Merged
merged 8 commits into from
Jan 23, 2023
Merged

feat(doc) Add doc generation with sphinx #19

merged 8 commits into from
Jan 23, 2023

Conversation

benoitblanc
Copy link
Contributor

closes #7

To build doc:

# install aditionnal dependencies
python -m pip install -U -r requirements/documentation.txt
# build it
sphinx-build -b html docs docs/_build

@benoitblanc benoitblanc marked this pull request as ready for review January 18, 2023 09:04
@benoitblanc benoitblanc changed the title Add doc generation with sphinx feat(doc) Add doc generation with sphinx Jan 18, 2023
@benoitblanc benoitblanc requested a review from lgrd January 18, 2023 09:05
@benoitblanc benoitblanc added documentation Improvements or additions to documentation sprint1 Issue or pull request related to sprint1 labels Jan 18, 2023
jmkerloch
jmkerloch requested changes Jan 18, 2023
View reviewed changes
docs/development/documentation.md Show resolved Hide resolved
docs/docker/readme.md Outdated Show resolved Hide resolved
jmkerloch
jmkerloch previously approved these changes Jan 18, 2023
View reviewed changes
Copy link
Contributor

@jmkerloch jmkerloch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems OK to me.

lgrd
lgrd reviewed Jan 19, 2023
View reviewed changes
requirements/base.txt Outdated Show resolved Hide resolved
@benoitblanc benoitblanc force-pushed the feature/add_doc_generation_with_sphinx branch from a56f0ef to 1722a24 Compare January 23, 2023 12:56
lgrd
lgrd approved these changes Jan 23, 2023
View reviewed changes
Copy link
Collaborator

@lgrd lgrd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok for me !

@benoitblanc benoitblanc merged commit 4c829ea into develop Jan 23, 2023
@jmkerloch jmkerloch deleted the feature/add_doc_generation_with_sphinx branch January 26, 2023 12:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lgrd lgrd lgrd approved these changes

@jmkerloch jmkerloch jmkerloch approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation sprint1 Issue or pull request related to sprint1
Projects
Road2 backlog
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[doc] Add documentation generation with sphinx
3 participants
@benoitblanc @lgrd @jmkerloch