Fix docs build: corrected filename #3260
Conversation
|
The documentation build (readthedocs) passed successfully, which was the main focus of this PR. This PR addresses issue #3249 by: Correcting the running-in-production.md filename and linking it properly in the toctree. |
|
@raisuraj2004 : There seems to be an error with readthedocs.io: https://app.readthedocs.org/projects/oss-augur/builds/29503183/ |
raisuraj2004
force-pushed
the
fix-docs-3249
branch
from
e845994 to
08a68d3
Compare
| sphinx-rtd-theme>=2.0,<3 | ||
|
|
||
| # Extensions | ||
| myst-parser>=2.0,<3 |
There was a problem hiding this comment.
I suspect it is the additional imports that are not being supported by readthedocs.io.
raisuraj2004
force-pushed
the
fix-docs-3249
branch
13 times, most recently
from
bf5ea20 to
576f6ad
Compare
Signed-off-by: SURYA RAI <raisuraj1947@gmail.com>
Signed-off-by: SURYA RAI <raisuraj1947@gmail.com>
Signed-off-by: SURYA RAI <raisuraj1947@gmail.com> Signed-off-by: raisuraj2004 <raisuraj1947@gmail.com> Signed-off-by: SURYA RAI <raisuraj1947@gmail.com>
Signed-off-by: SURYA RAI <raisuraj1947@gmail.com> Signed-off-by: raisuraj2004 <raisuraj1947@gmail.com> Signed-off-by: SURYA RAI <raisuraj1947@gmail.com>
Signed-off-by: SURYA RAI <raisuraj1947@gmail.com> Signed-off-by: raisuraj2004 <raisuraj1947@gmail.com> Signed-off-by: SURYA RAI <raisuraj1947@gmail.com>
Signed-off-by: SURYA RAI <raisuraj1947@gmail.com> Signed-off-by: raisuraj2004 <raisuraj1947@gmail.com> Signed-off-by: SURYA RAI <raisuraj1947@gmail.com>
Signed-off-by: SURYA RAI <raisuraj1947@gmail.com> Signed-off-by: raisuraj2004 <raisuraj1947@gmail.com> Signed-off-by: SURYA RAI <raisuraj1947@gmail.com>
Signed-off-by: SURYA RAI <raisuraj1947@gmail.com> Signed-off-by: raisuraj2004 <raisuraj1947@gmail.com> Signed-off-by: SURYA RAI <raisuraj1947@gmail.com>
Signed-off-by: SURYA RAI <raisuraj1947@gmail.com> Signed-off-by: raisuraj2004 <raisuraj1947@gmail.com> Signed-off-by: SURYA RAI <raisuraj1947@gmail.com>
raisuraj2004
force-pushed
the
fix-docs-3249
branch
from
576f6ad to
3a6e340
Compare
|
I’ve updated the commits and pushed the latest changes. |
There was a problem hiding this comment.
since we are already using uv for dependency management, having a requirements.txt seems redundant.
Was it difficult for you to use uv to install what you needed? do the docs need improving in that regard?
| with: | ||
| python-version: '3.10' | ||
| - name: Install doc requirements | ||
| run: pip install -r docs/requirements.txt |
There was a problem hiding this comment.
uv is installed in the prior command, using that would probably be better - happy to help get this working if you get stuck!
There was a problem hiding this comment.
This PR seems to contain a lot of various fixes to the point that I'm having a hard time identifying which filename was "corrected" per the title of this PR or what specific issue with ReadTheDocs this is intended to resolve.
It seems like this PR's core change is to create a new "running augur in production" document - is that correct?
| Make sure to configure the following environment variables: | ||
|
|
||
| - `AUGUR_RESET_LOGS`: Determines whether logs should be reset on startup. | ||
| - `REFRESH_MATERIALIZED_VIEWS_INTERVAL_IN_DAYS`: Controls how often materialized views are refreshed. (Default: 1 day) |
There was a problem hiding this comment.
This is not an environment variable that exists in augur
| os: ubuntu-22.04 # <- add this line | ||
| os: ubuntu-22.04 |
There was a problem hiding this comment.
was Generative AI used as part of the creation of this commit?
MoralCode
added
the
more info needed
Description
running-in-production.mdunderdocs/source/.index.rsttoctree to include the new page.This PR fixes #3249
Notes for Reviewers
Signed commits