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

STYLE: Make documentation module consistent with Sphinx conventions #79

Merged

Conversation

jhlegarreta
Copy link
Contributor

@jhlegarreta jhlegarreta commented Oct 22, 2023

Make the documentation module consistent with Sphinx conventions:

  • Rename the module to docs.
  • Host the configuration file and index file in docs/sources. Chang the makefile SOURCEDIR variable accordingly.

Change the bibliography references paths accordingly in the README
file.

@github-actions github-actions bot added the type:documentation Improvements or additions to documentation label Oct 22, 2023
@jhlegarreta
Copy link
Contributor Author

PR #78 should be merged before this.

@github-actions github-actions bot added the type:style Style changes label Oct 22, 2023
@jhlegarreta jhlegarreta changed the title STYLE: Make doc module consistent with Sphinx conventions STYLE: Make documentation module consistent with Sphinx conventions Oct 22, 2023
@github-actions github-actions bot added type:style Style changes and removed type:style Style changes labels Oct 22, 2023
@github-actions github-actions bot added type:style Style changes and removed type:style Style changes labels Oct 28, 2023
@github-actions github-actions bot added type:style Style changes and removed type:style Style changes labels Oct 28, 2023
@github-actions github-actions bot added type:style Style changes and removed type:style Style changes labels Oct 28, 2023
@github-actions github-actions bot added type:style Style changes and removed type:style Style changes labels Oct 28, 2023
@github-actions github-actions bot added type:style Style changes and removed type:style Style changes labels Oct 28, 2023
@github-actions github-actions bot added type:style Style changes and removed type:style Style changes labels Oct 29, 2023
@github-actions github-actions bot added type:style Style changes and removed type:style Style changes labels Dec 4, 2023
@jhlegarreta jhlegarreta marked this pull request as ready for review December 4, 2023 14:18
Make the documentation module consistent with Sphinx conventions:
- Rename the module to `docs`.
- Host the configuration file and index file in `docs/sources`. Change
  the makefile `SOURCEDIR` variable accordingly.

Change the bibliography references paths accordingly in the `README`
file.
@github-actions github-actions bot added type:style Style changes and removed type:style Style changes labels Dec 4, 2023
@jhlegarreta jhlegarreta merged commit 9c52a44 into scil-vital:main Dec 4, 2023
8 checks passed
@jhlegarreta jhlegarreta deleted the IncreaseDocModuleConsistency branch December 4, 2023 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:documentation Improvements or additions to documentation type:style Style changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant