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.

Sign up for GitHub

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

Jump to bottom

Update the conda environment to create the documentation locally #1411

Merged
merged 8 commits into from
Mar 20, 2020
Merged

Update the conda environment to create the documentation locally #1411

merged 8 commits into from
Mar 20, 2020

Conversation

steffengraber
Copy link
Contributor

This PR updates the file for creating the conda environment to build the documentation locally. The corresponding README file is updated accordingly.

@terhorstd terhorstd added ZC: Infrastructure DO NOT USE THIS LABEL I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) ZP: PR Created DO NOT USE THIS LABEL S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. labels Feb 19, 2020
@heplesser heplesser mentioned this pull request Mar 17, 2020
Merged
heplesser
heplesser requested changes Mar 17, 2020
View reviewed changes
Copy link
Contributor

@heplesser heplesser left a comment

Choose a reason for hiding this comment

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

@steffengraber Looks good to me except for name-change suggestions.

doc/conda_environment.yml Outdated
@@ -1,73 +1,51 @@
name: doc
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't we call the environment nest_doc, since users may have many different environments for work on all kind of software.

I would also suggest to rename the file to nest_doc_conda_env.yml.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Very good idea. It' done.

@heplesser heplesser requested a review from babsey March 17, 2020 16:02
@heplesser heplesser added S: High Should be handled next and removed S: Normal Handle this with default priority labels Mar 17, 2020
@heplesser
Copy link
Contributor

Escalated to "high", since #1439 is blocked by this one.

heplesser
heplesser approved these changes Mar 18, 2020
View reviewed changes
Copy link
Contributor

@heplesser heplesser left a comment

Choose a reason for hiding this comment

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

@steffengraber Thanks!
@sarakonradi Would you adjust the workflow documentation in #1439 to these name changes?

@sarakonradi sarakonradi mentioned this pull request Mar 18, 2020
Closed
24 tasks
@sarakonradi
Copy link
Contributor

@sarakonradi Would you adjust the workflow documentation in #1439 to these name changes?

Done.

@heplesser heplesser removed the request for review from babsey March 20, 2020 11:49
@heplesser
Copy link
Contributor

Since this PR only addresses details on local building of documentation relevant for developers, I merge without further review.

@heplesser heplesser merged commit d3d110f into nest:master Mar 20, 2020
@steffengraber steffengraber deleted the doc-environment branch September 6, 2023 05:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@heplesser heplesser heplesser approved these changes

Assignees
No one assigned
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: High Should be handled next T: Maintenance Work to keep up the quality of the code and documentation. ZC: Infrastructure DO NOT USE THIS LABEL ZP: PR Created DO NOT USE THIS LABEL
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@steffengraber @heplesser @sarakonradi @terhorstd