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 documentation (+ add tox configuration) #643

Merged
merged 8 commits into from
Feb 3, 2021

Conversation

chrisjsewell
Copy link
Member

@chrisjsewell chrisjsewell commented Feb 3, 2021

The documentation CLI is not set up correctly, which has "hidden" a multitude of issues in the documentation build

@chrisjsewell
Copy link
Member Author

FYI the docs are building with a bunch of warnings: https://readthedocs.org/projects/aiida-quantumespresso/builds/12867318/

@chrisjsewell
Copy link
Member Author

chrisjsewell commented Feb 3, 2021

@sphuber can you add me as a maintainer for the readthedocs: https://readthedocs.org/projects/aiida-quantumespresso/ (my username is cjsewell). The current maintainer is an aiida profile, do you have the login details for that?

(I just want to move the docs build CI to RTD, as we now have in aiida-core)

@chrisjsewell chrisjsewell changed the title Add tox configuration Add tox configuration & fix docs Feb 3, 2021
@chrisjsewell
Copy link
Member Author

https://github.com/aiidateam/aiida-tcod is not available on PyPi, and so the tcod extra does not work (and so autodoc fails for docs/source/module_guide/tcod_dbexporter.rst).
Given this, I assume also that the aiida_quantumespresso/tools/dbexporters/tcod_plugins code is not at all tested.

aiida-tcod has not been updated for two years, so I think this code should just be removed and the repo archived (cc also @ltalirz who was the last to commit to that repo)

@ltalirz
Copy link
Member

ltalirz commented Feb 3, 2021

@chrisjsewell I only merged a PR to aiida-tcod - aiida-tcod was handled by @sphuber

@chrisjsewell
Copy link
Member Author

chrisjsewell commented Feb 3, 2021

I assume you are no longer using the plugin though?

@chrisjsewell
Copy link
Member Author

chrisjsewell commented Feb 3, 2021

Next issue: the docs/source/devel_guide/workchains.rst is completely out of date, since the BaseRestartWorkChain has been moved to to aiida-core.
We should remove most of this page; linking to the relevant documentation in aiida-core and only mentioning information specific to aiida-quantumespresso.

aiidateam/aiida-core#4562 is opened by @mbercx to fix aiidateam/aiida-core#3993, but I don't yet see any documentation specific to BaseRestartWorkChain?

(moved to #645)

@chrisjsewell
Copy link
Member Author

chrisjsewell commented Feb 3, 2021

Finally, there is a bunch of references, that presumably have been renamed, removed or moved to aiida-core:

/Users/chrisjsewell/Documents/GitHub/aiida-quantumespresso-develop/docs/source/user_guide/get_started/examples/cp_tutorial.rst:145: WARNING: undefined label: my-ref-to-pseudo-tutorial
/Users/chrisjsewell/Documents/GitHub/aiida-quantumespresso-develop/docs/source/user_guide/get_started/examples/ph_tutorial.rst:89: WARNING: undefined label: my-reference-to-scheduler
/Users/chrisjsewell/Documents/GitHub/aiida-quantumespresso-develop/docs/source/user_guide/get_started/examples/pw_tutorial.rst:129: WARNING: undefined label: working_calculations
/Users/chrisjsewell/Documents/GitHub/aiida-quantumespresso-develop/docs/source/user_guide/get_started/examples/pw_tutorial.rst:129: WARNING: undefined label: concepts_processes
/Users/chrisjsewell/Documents/GitHub/aiida-quantumespresso-develop/docs/source/user_guide/get_started/examples/pw_tutorial.rst:192: WARNING: undefined label: structure_tutorial
/Users/chrisjsewell/Documents/GitHub/aiida-quantumespresso-develop/docs/source/user_guide/get_started/examples/pw_tutorial.rst:235: WARNING: undefined label: my-ref-to-structure
/Users/chrisjsewell/Documents/GitHub/aiida-quantumespresso-develop/docs/source/user_guide/get_started/examples/pw_tutorial.rst:249: WARNING: undefined label: structure_tutorial
/Users/chrisjsewell/Documents/GitHub/aiida-quantumespresso-develop/docs/source/user_guide/get_started/examples/pw_tutorial.rst:562: WARNING: undefined label: my-ref-to-pseudo-tutorial
/Users/chrisjsewell/Documents/GitHub/aiida-quantumespresso-develop/docs/source/user_guide/get_started/examples/pw_tutorial.rst:648: WARNING: undefined label: working_processes_launching

@chrisjsewell chrisjsewell changed the title Add tox configuration & fix docs Fix documentation (+ add tox configuration) Feb 3, 2021
@ltalirz
Copy link
Member

ltalirz commented Feb 3, 2021

I assume you are no longer using the plugin though?

I've never used it. I suggest to let @sphuber or @giovannipizzi decide about the fate of this code

@chrisjsewell
Copy link
Member Author

chrisjsewell commented Feb 3, 2021

I've never used it. I suggest to let @sphuber or @giovannipizzi decide about the fate of this code

ok thanks, I have moved this to a separate issue #644

@chrisjsewell
Copy link
Member Author

ok ready for review

@chrisjsewell chrisjsewell requested a review from mbercx February 3, 2021 16:05
Copy link
Member

@mbercx mbercx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @chrisjsewell!

@chrisjsewell chrisjsewell merged commit 3c4c8e6 into aiidateam:develop Feb 3, 2021
@chrisjsewell chrisjsewell deleted the add-tox branch February 3, 2021 16:13
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

Successfully merging this pull request may close these issues.

3 participants