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

Documentation on buiding docs is outdated #2089

Closed
2 tasks done
AlexHls opened this issue Jul 13, 2022 · 2 comments · Fixed by #2097
Closed
2 tasks done

Documentation on buiding docs is outdated #2089

AlexHls opened this issue Jul 13, 2022 · 2 comments · Fixed by #2097
Assignees
Labels

Comments

@AlexHls
Copy link
Member

AlexHls commented Jul 13, 2022

Describe the bug

The documentation https://tardis-sn.github.io/tardis/contributing/development/documentation_guidelines.html#sharing-the-built-documentation-in-your-pr-documentation-preview says a commit with
git commit --allow-empty -m "[build docs]"
will build the docs. The workflow file requires build-docs in the commit message.
Furthermore, the documentation does not build either way

To Reproduce

See PR #2088

Screenshots

System

  • OS:

    • GNU/Linux
    • macOS
  • Environment (conda list):

Additional context

@epassaro
Copy link
Member

I would remove the documentation build section since the pull request template says clearly what you need to do in order to build the docs (just apply the build-docs label).

@isaacgsmith
Copy link
Member

I strongly disagree since we still need to document where to access the built documentation, how to view build logs, and how to build docs online if the branch isn't part of an open PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants