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

Feature/sphinx doc #1

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Feature/sphinx doc #1

wants to merge 2 commits into from

Conversation

nvitucci
Copy link
Owner

@nvitucci nvitucci commented Apr 20, 2021

This is a stab at converting the existing doc into Sphinx format. To achieve this, I:

  • created a doc/sphinx/source folder via sphinx-quickstart;
  • copied over the doc/source folder into doc/sphinx/source (excluding doc/source/bin);
  • renamed all the .txt files to .rst (for clarity);
  • removed the internal links files (e.g. source/knowledge_bases/links) by adding their links to the main links file (renaming them when necessary);
  • removed the restindex and uservalues sections in each .rst file (replacing them with a toctree element in the inner index.rst files).

Once the new generated doc is checked, the doc/source folder can be removed.

@nvitucci nvitucci requested a review from dangyogi April 20, 2021 20:47
Copy link

@Mandroide Mandroide left a comment

Choose a reason for hiding this comment

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

Use an imperative tone to describe what a commit does, rather than what it did.

Source:
Udacity Git Commit Message Style Guide

@nvitucci
Copy link
Owner Author

Use an imperative tone to describe what a commit does, rather than what it did.

Source:
Udacity Git Commit Message Style Guide

Thanks for the suggestion, I will do that in the next commits. I would appreciate a review on the content as well.

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