Skip to content

Reconcile environment for development and docs building #717

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

Merged
merged 14 commits into from
Apr 21, 2024

Conversation

HangenYuu
Copy link
Contributor

@HangenYuu HangenYuu commented Apr 15, 2024

Description

Updated the environment.yml for developing and docs building locally.

Related Issue

Checklist

Type of change

  • New feature / enhancement
  • Bug fix
  • Documentation
  • Maintenance
  • Other (please specify):

@HangenYuu
Copy link
Contributor Author

HangenYuu commented Apr 15, 2024

Maybe not merge yet. Let me update the documentation first. I opened the PR first though.

@ricardoV94 ricardoV94 requested a review from OriolAbril April 15, 2024 16:03
@ricardoV94 ricardoV94 marked this pull request as draft April 15, 2024 16:03
@ricardoV94
Copy link
Member

ricardoV94 commented Apr 15, 2024

Maybe not merge yet. Let me update the documentation first. I opened the PR first though.

You can click Convert to a draft button when a PR is not ready (I did that now). That way there's no risk of premature merging. Anytime it's ready you click Ready for review

@HangenYuu HangenYuu marked this pull request as ready for review April 16, 2024 12:36
@HangenYuu
Copy link
Contributor Author

Okay I have also updated the documentation. The change should be good for merging.

@OriolAbril
Copy link
Member

Is anyone using the docgen.py script for something other than to generate the html build of the docs? I was just going over it and it basically calls sphinx with different defaults (such as default to building both html and pdf via latex instead of only building html).

If it isn't really being used (doc building and PR previews via readthedocs do not use it for example), it is probably best to remove and update the contributing guide a bit more to use the sphinx command directly instead of running docgen script

environment.yml Outdated
@@ -37,6 +37,9 @@ dependencies:
- pygments
- pydot
- ipython
- pip
Copy link
Member

Choose a reason for hiding this comment

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

It can be installed from conda forge too, no need to include pip and install from github

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When I search on conda libraries website I did not find the theme. In the GitHub workflow I also see that it is published on PyPI only, so I follows that environment.yml in the doc folder 😅. Can you give me the conda package website like this one: https://anaconda.org/conda-forge/pydata-sphinx-theme?

Copy link
Member

Choose a reason for hiding this comment

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

The one in the doc folder should also be updated then. Link: https://anaconda.org/conda-forge/pymc-sphinx-theme

@HangenYuu
Copy link
Contributor Author

Is anyone using the docgen.py script for something other than to generate the html build of the docs? I was just going over it and it basically calls sphinx with different defaults (such as default to building both html and pdf via latex instead of only building html).

If it isn't really being used (doc building and PR previews via readthedocs do not use it for example), it is probably best to remove and update the contributing guide a bit more to use the sphinx command directly instead of running docgen script

Agreed. Let me deal with this.

@HangenYuu
Copy link
Contributor Author

@OriolAbril

  • Updated the dependency to install from conda-forge instead of pip.
  • Removed the script & updated the developer guide.

@ricardoV94
Copy link
Member

Thanks a ton @HangenYuu

@ricardoV94 ricardoV94 merged commit 0727538 into pymc-devs:main Apr 21, 2024
14 checks passed
@HangenYuu HangenYuu deleted the environment-reconcile branch April 25, 2024 01:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants