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

Automate API doc building #435

Merged
merged 4 commits into from
Jan 26, 2022
Merged

Automate API doc building #435

merged 4 commits into from
Jan 26, 2022

Conversation

nicolasbock
Copy link
Collaborator

@nicolasbock nicolasbock commented Dec 26, 2020 •
edited
Loading

Signed-off-by: Nicolas Bock nicolasbock@gmail.com

This change is Reviewable

@nicolasbock nicolasbock self-assigned this Dec 26, 2020
@github-actions
Copy link

github-actions bot commented Dec 4, 2021

This PR is stale because it has been open for 90 days with no activity.

@github-actions github-actions bot added the Stale label Dec 4, 2021
@nicolasbock
Automate API doc building
a119957 
Signed-off-by: Nicolas Bock <nicolasbock@gmail.com>
@jmohdyusof
Copy link
Collaborator

Don't we need sphinx_rtd_theme instead of alabaster for the html theme?

@nicolasbock
Copy link
Collaborator Author

Don't we need sphinx_rtd_theme instead of alabaster for the html theme?

Yes possibly. I am still trying to get the PR to build on readthedocs to see what the result looks like.

@nicolasbock
Add Sphinx configuration file
d25d434 
Signed-off-by: Nicolas Bock <nicolasbock@gmail.com>
@github-actions github-actions bot removed the Stale label Jan 26, 2022
@nicolasbock
Rename README.md to README.rst
b4a7c09 
Signed-off-by: Nicolas Bock <nicolasbock@gmail.com>
@nicolasbock
Transition markdown to ReStructuredText
81d0f48 
Signed-off-by: Nicolas Bock <nicolasbock@gmail.com>
@nicolasbock nicolasbock merged commit d0d61cf into lanl:master Jan 26, 2022
@nicolasbock nicolasbock deleted the readthedocs branch January 26, 2022 15:17
@jmohdyusof
Copy link
Collaborator

The top-level readme is not included unless you add it to the source/index.rst. Note also that you cannot specify relative paths (above the source directory) easily in sphinx, so you need to use an include file, or move the doc to within source (In other projects I have a source/usage subdir for this).

@nicolasbock
Copy link
Collaborator Author

Locally the docs are building for me. I submitted #574 to fix some stylistic issues and hopefully that will address the build failure on rtd (https://readthedocs.org/projects/basic-matrix-library/builds/15891598/)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@suemni suemni suemni approved these changes

@cnegre cnegre Awaiting requested review from cnegre cnegre is a code owner

@jeanlucf22 jeanlucf22 Awaiting requested review from jeanlucf22 jeanlucf22 is a code owner

@jmohdyusof jmohdyusof Awaiting requested review from jmohdyusof jmohdyusof is a code owner

@tokshgithub tokshgithub Awaiting requested review from tokshgithub tokshgithub is a code owner

Assignees

@nicolasbock nicolasbock

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@nicolasbock @jmohdyusof @suemni