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

Remove references to tudat-multidoc #21

Open
yiquintero opened this issue Oct 16, 2024 · 0 comments · Fixed by #23
Open

Remove references to tudat-multidoc #21

yiquintero opened this issue Oct 16, 2024 · 0 comments · Fixed by #23
Assignees

Comments

@yiquintero
Copy link

yiquintero commented Oct 16, 2024

Description

As described in issue 150, of the tudatpy repository, tudat-multidoc and it's functionality are being phased-out in favour of a simpler way to generate the tudatpy API docs. For this reason, all references to multidoc must be removed from this repository.

Solution

Remove lines 6-11 in recipe/build.sh. These lines refer to a file used as part of the tudat-multidoc pipelines.

At the moment, the lines need to be removed only from the develop branch since tudatpy's master branch is still using the multidoc logic. Once tudatpy's develop branch is merged into master, the aforementioned lines can be removed from the master branch as well.

Note: it is safe to remove these lines as its removal was tested by commenting-them out and making sure the Azure pipelines ran successfully and the online API docs were rendered without issues.

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

Successfully merging a pull request may close this issue.

1 participant