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

requirements.txt in docs/ lists AeoLiS v2.0.0.dev2 as a dependency while the latest stable is v2.1.1 #121

Closed
niketagrawal opened this issue Jun 13, 2023 · 9 comments
Assignees
Labels
Milestone

Comments

@niketagrawal
Copy link
Collaborator

The requirements.txt file in docs/ contains the dependencies required to build the documentation and generate rendered html pages locally, however, installing the dependencies using this file would overwrite the existing installation of AeoLiS with the older version.

To check: Is Read the docs using docs/requirements.txt for installing dependencies to build the documentation? If yes, AeoLiS v2.0.0.dev2 in docs/requirements.txt should be replaced with AeoLiS

@manuGil manuGil self-assigned this Jun 20, 2023
@manuGil manuGil added the bug label Jun 28, 2023
@manuGil
Copy link
Collaborator

manuGil commented Jun 28, 2023

According to RTD, the requirements.txt is used to pass dependencies that are used by their platform to build the documentation. It is not expected that we will be using that file in any other case. However, we probably want to point out the latest research always.

Heres's an explanation of the purpose of that file: https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html

@manuGil manuGil added this to the Handing over milestone Jun 28, 2023
@manuGil
Copy link
Collaborator

manuGil commented Jun 28, 2023

  • The sphinxcontrib-napoleon is now packed with Sphinx, no need to install it separately.
  • The sphinxcontrib-bibtex is not used in the documentation. We should remove it

@manuGil
Copy link
Collaborator

manuGil commented Jun 28, 2023

@niketagrawal I test compiling the documentation using your branch on decomposition. I still see several issues regarding missing references and loading extensions. Is that the same for you? Shall I fix them?

@manuGil
Copy link
Collaborator

manuGil commented Jun 29, 2023

Read The Docs will make the use of a configuration file compulsory in September. I added it to the the docs/build branch already. I will be merge along with other fixes.

The Read the Docs build system will start requiring a configuration file v2 (.readthedocs.yaml) starting on September 25, 2023. We are sending weekly notifications about this issue to all impacted users, as well as temporary build failures (brownouts) as the date approaches for those who haven't migrated their projects. The timeline for this deprecation is as follows:
Monday, July 24, 2023: Do the first brownout (temporarily enforce this deprecation) for 12 hours: 00:01 PST to 11:59 PST (noon)
Monday, August 14, 2023: Do a second brownout (temporarily enforce this deprecation) for 24 hours: 00:01 PST to 23:59 PST (midnight)
Monday, September 4, 2023: Do a third and final brownout (temporarily enforce this deprecation) for 48 hours: 00:01 PST to September 5, 2023 23:59 PST (midnight)
Monday, September 25, 2023: Fully remove support for building documentation without configuration file v2.

@manuGil
Copy link
Collaborator

manuGil commented Jun 29, 2023

The reference to equation equilibrium-transport in the model description is missing, from the model.rst

@Sierd Could you please check if the equation appears in the file? Maybe the equation is there but it has a differnt name. Or it was moved to another file.

Multi-fraction Erosion and Deposition
-------------------------------------

The formulation for the equilibrium or saturated sediment
concentration :math:`c_{\mathrm{sat}}` (Equation
:eq:`equilibrium-transport`) is capable of dealing with variations in
grain size through the variables :math:`u_{\mathrm{th}}`,

@niketagrawal
Copy link
Collaborator Author

@niketagrawal I test compiling the documentation using your branch on decomposition. I still see several issues regarding missing references and loading extensions. Is that the same for you? Shall I fix them?

@manuGil , thanks for checking this. I do see several warnings about incorrect formatting and missing references. Sure, please go ahead with the fix. Thanks again.

@manuGil
Copy link
Collaborator

manuGil commented Jun 30, 2023

@niketagrawal I test compiling the documentation using your branch on decomposition. I still see several issues regarding missing references and loading extensions. Is that the same for you? Shall I fix them?

@manuGil , thanks for checking this. I do see several warnings about incorrect formatting and missing references. Sure, please go ahead with the fix. Thanks again.

@niketagrawal I fixed all of them, except the one about the missing reference to the equilibrium-transport.

@manuGil
Copy link
Collaborator

manuGil commented Jul 5, 2023

Equilibrium transport is the Csat equation

@niketagrawal
Copy link
Collaborator Author

Closed with #134

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

No branches or pull requests

2 participants