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

./doc/build_docs for Epetra #1431

Closed
nschloe opened this issue Jun 15, 2017 · 9 comments
Closed

./doc/build_docs for Epetra #1431

nschloe opened this issue Jun 15, 2017 · 9 comments
Labels
CLOSED_DUE_TO_INACTIVITY Issue or PR has been closed by the GitHub Actions bot due to inactivity. MARKED_FOR_CLOSURE Issue or PR is marked for auto-closure by the GitHub Actions bot. pkg: Epetra

Comments

@nschloe
Copy link
Member

nschloe commented Jun 15, 2017

The most common way for a Trilinos package to build its docs is to call ./doc/build_docs. Unfortunately, Epetra doesn't have that, meaning that the Debian package, for example, doesn't contain Epetra docs. We've recently had a user point that out, so I thought I mention it here, hoping for someone to put a ./doc/build_docs in Epetra.

@mhoemmen
Copy link
Contributor

@trilinos/epetra

@ibaned
Copy link
Contributor

ibaned commented Jun 15, 2017

@trilinos/epetra isn't a team... @trilinos/framework someone needs to determine ownership of Epetra and create the @trilinos/epetra team...

@jwillenbring
Copy link
Member

@nschloe what version are you looking at? I see such a file in the repo: https://github.com/trilinos/Trilinos/blob/master/packages/epetra/doc/build_docs

We rely on this for the official deoxygenated generation for the website.

@nschloe
Copy link
Member Author

nschloe commented Jun 15, 2017

Thanks @jwillenbring for the reply.

I looked at the 12.10.1 release where you'll find

$ ls -l packages/epetra/
browser
cmake
CMakeLists.txt
Copyright.txt
example
ReleaseNotes.txt
src
test

– no docs/. They are in master however. Those files don't get filtered out in the release process, do they?

@bmpersc
Copy link
Contributor

bmpersc commented Jun 15, 2017

@nschloe Epetra does have an exclusion for the doc directory for the tarball release. It should still be there on the 12.10 branch, but not in the tarball(s) made from that branch.

I'm not sure what the specific reason for that exclusion was/is, but it could have been that there were documents that hadn't gone through the appropriate review process. Given that we are now releasing it as part of our repo those reviews should have already happened and would allow us to stop excluding that directory from the tarball. Is Epetra the only package this is an issue for or just the only one that has been noticed? I would suspect there are others.

@nschloe
Copy link
Member Author

nschloe commented Jun 16, 2017

I would suspect there are others.

I guess there'll be others, but people don't really look at locally installed documentation anymore. Frankly I was surprised that the lack of Epetra (of all packages) got noticed at all. If that could be fixed for the next release, I could close the bug on the Debian side.

@mhoemmen
Copy link
Contributor

I made an Epetra team: @trilinos/epetra

@github-actions
Copy link

This issue has had no activity for 365 days and is marked for closure. It will be closed after an additional 30 days of inactivity.
If you would like to keep this issue open please add a comment and remove the MARKED_FOR_CLOSURE label.
If this issue should be kept open even with no activity beyond the time limits you can add the label DO_NOT_AUTOCLOSE.

@github-actions github-actions bot added the MARKED_FOR_CLOSURE Issue or PR is marked for auto-closure by the GitHub Actions bot. label Mar 27, 2021
@github-actions
Copy link

This issue was closed due to inactivity for 395 days.

@github-actions github-actions bot added the CLOSED_DUE_TO_INACTIVITY Issue or PR has been closed by the GitHub Actions bot due to inactivity. label Apr 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLOSED_DUE_TO_INACTIVITY Issue or PR has been closed by the GitHub Actions bot due to inactivity. MARKED_FOR_CLOSURE Issue or PR is marked for auto-closure by the GitHub Actions bot. pkg: Epetra
Projects
None yet
Development

No branches or pull requests

5 participants