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

Migrate OpenMS documentation to github pages or readthedocs. #235

Open
JKVISION1101 opened this issue Aug 8, 2024 · 3 comments
Open

Migrate OpenMS documentation to github pages or readthedocs. #235

JKVISION1101 opened this issue Aug 8, 2024 · 3 comments

Comments

@JKVISION1101
Copy link

Hi,

I have been assigned the task mentioned above.

First, I would like to know how to download the Doxygen and documentation files stored in abibuilder.

Second, I would appreciate any tips or precautions necessary for the process of migrating the documentation.

@matteopilz
Copy link
Collaborator

@jpfeuffer, do you have an idea?

@jpfeuffer
Copy link
Collaborator

  • create sphinx folder in docs
  • add conf.py for sphinx
  • follow https://stackoverflow.com/questions/36064976/using-doxygen-in-read-the-docs
  • change doxygen command to our cmake docs command
  • deploy on read the docs with appropriate settings (environment.yml with cmake doxygen etc, correct paths, add tags to build from)
  • pray to some deity that it does not timeout (tutorials etc or anything that requires compiling is most likely out of scope anyway)

@jpfeuffer
Copy link
Collaborator

Maybe you can avoid building if you download GitHub artifacts but I think it might be hard to do that reliably.

If you need to download docs from abibuilder IMO you don't gain anything. It will still be dependent on abibuilder.

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

No branches or pull requests

3 participants