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

Fix sphinx warnings #46

Open
DrDaveD opened this issue Feb 1, 2022 · 6 comments
Open

Fix sphinx warnings #46

DrDaveD opened this issue Feb 1, 2022 · 6 comments

Comments

@DrDaveD
Copy link
Contributor

DrDaveD commented Feb 1, 2022

Doing 'make html' or 'make epub' prints a bunch of warnings that are currently ignored. They can also be seen in CI runs. Fix the warnings.

@DrDaveD DrDaveD added this to the v1.0.0 milestone Feb 1, 2022
@pedroalvesbatista
Copy link
Contributor

I suppose those are contained at Makefile and cli folder, correct ?

@DrDaveD
Copy link
Contributor Author

DrDaveD commented Feb 3, 2022

No. Try running 'make html' in your workspace. It does require having sphinx installed on your machine and a copy of the https://github.com/apptainer/apptainer source in an apptainer_source subdirectory. Or look at the detailed log of a CI run from any pull request in this repository.

@pedroalvesbatista
Copy link
Contributor

No. Try running 'make html' in your workspace. It does require having sphinx installed on your machine and a copy of the https://github.com/apptainer/apptainer source in an apptainer_source subdirectory. Or look at the detailed log of a CI run from any pull request in this repository.

I tried that, and there is a need to run git submodule init and then git submodule update to fetch apptainer_source.

And agree, there are a bunch or warnings that are kind of unnecessary or at least little informative. So, the best way now would be to decide which message we should provide, is that it ?

@DrDaveD
Copy link
Contributor Author

DrDaveD commented Feb 3, 2022

Yes, decide which messages we should fix.

@DrDaveD DrDaveD removed this from the v1.0.0 milestone Mar 1, 2022
@symgryph
Copy link

symgryph commented Mar 6, 2022

This also fixes 'mconfig' missing. Probably need to update the readme "git submodule init && git submodule update && make epub

@DrDaveD
Copy link
Contributor Author

DrDaveD commented Mar 7, 2022

Let's update the README with issue #82.

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

No branches or pull requests

3 participants