Skip to content

Fix: build docs by setting repo_name as project_name to #158

Merged
orbeckst merged 5 commits into
MDAnalysis:mainfrom
ojeda-e:issue157-fix-docs-build
May 4, 2026
Merged

Fix: build docs by setting repo_name as project_name to #158
orbeckst merged 5 commits into
MDAnalysis:mainfrom
ojeda-e:issue157-fix-docs-build

Conversation

@ojeda-e

@ojeda-e ojeda-e commented May 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Fixes #157

Changes made in this Pull Request:

  • Changes repo_name from "example-repository" to project_name.

PR Checklist

  • Tests?
  • [N/A] Docs?
  • CHANGELOG.md updated?
  • AUTHORS.md updated?
  • Issue raised/referenced?

@ojeda-e

ojeda-e commented May 4, 2026

Copy link
Copy Markdown
Member Author

@orbeckst I think this solves the broken docs. Then we can have the CI passing in your PR #155 and mine in #156

I'll opening later today for review but let me know if you spot anything so far.

@ojeda-e ojeda-e marked this pull request as ready for review May 4, 2026 22:46
ojeda-e
ojeda-e commented May 4, 2026
View reviewed changes
Comment thread tests/test_generate_cookiecutter_cli.py

@ojeda-e ojeda-e May 4, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I may be overkilling it with this. IMO when in doubt, better add a test.

orbeckst
orbeckst approved these changes May 4, 2026
View reviewed changes

@orbeckst orbeckst left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm!

Comment thread CHANGELOG.md Outdated
@orbeckst orbeckst merged commit 938abd0 into MDAnalysis:main May 4, 2026
@orbeckst orbeckst mentioned this pull request May 5, 2026
Closed
@orbeckst

orbeckst commented May 5, 2026

Copy link
Copy Markdown
Member

I think I merged this prematurely, see #157 (comment) .

@orbeckst

orbeckst commented May 5, 2026

Copy link
Copy Markdown
Member

RTD https://app.readthedocs.org/projects/cookiecutter-mdakit/builds/32535006/ also complains

      File "/home/docs/checkouts/readthedocs.org/user_builds/cookiecutter-mdakit/conda/156/lib/python3.14/shutil.py", line 652, in copytree
        with os.scandir(src) as itr:
             ~~~~~~~~~~^^^^^
    FileNotFoundError: [Errno 2] No such file or directory: '/tmp/tmphkaqo5rb/my_project_name'

@orbeckst

orbeckst commented May 5, 2026

Copy link
Copy Markdown
Member

I should have looked more closely at the CI and noticed that only one job had run and that one was green. I only afterwards realized that almost all workflows had been disabled and needed to be manually enabled again.

ojeda-e added a commit to ojeda-e/cookiecutter-mdakit that referenced this pull request May 5, 2026
@ojeda-e
Fix: build docs by setting repo_name as project_name to (MDAnalysis#158)
9d12ddf 
* fix MDAnalysis#157
* Fix: set repo_name from project_name in the cookiecutter cli script when docs are auto generated:
  changes repo_name from "example-repository" to project_name.
  Set same name as in ExampleRepositoryDocumentation
* update sphinx conf
* Add tests - project name matches
* Update AUTHORS and CHANGELOG
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@orbeckst orbeckst orbeckst approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Docs: Sphinx build fails with FileNotFoundError in generate_cookiecutter_cli.py due to missing output directory

2 participants

@ojeda-e @orbeckst