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

Documentation not building #188

Closed
IanSudbery opened this issue Nov 22, 2024 · 5 comments
Closed

Documentation not building #188

IanSudbery opened this issue Nov 22, 2024 · 5 comments

Comments

@IanSudbery
Copy link
Contributor

As I expand the range of people using cgatcore, the lack of documentation is becomeing more and more of a problem.

I believe this is because there is no .readthedocs.yml, nor documentation requirements.

@Acribbs
Copy link
Contributor

Acribbs commented Nov 22, 2024

yes this is because im in the process of transitioning towards mkdocs here (first few commits last week or two): https://cgat-developers.github.io/cgat-core/. Docs are now automatically built using github actions and then pushed to github pages. I have been trying to keep the hosting with readthedocks and using webhook but its frustrating me and I temp gave up, but have plans to give it another go

@IanSudbery
Copy link
Contributor Author

Is there anything I can do to help? Seems the github pages are simlar to the readthedocs pages, in that the static pages are generating well, but many of the autogenerated pages are still empty.

@Acribbs
Copy link
Contributor

Acribbs commented Nov 25, 2024

yes at the moment im just trying to build on mkdocs as its easier to host on github than readthedocs, but also trying to get a hook for building on readthedocs. Documentation needs improving throught though, unless im mistaken I can see on gihub pages that the autogenerated pages are now building.

@IanSudbery
Copy link
Contributor Author

The pipeline pages, yes, but the "Core" pages, no.

@Acribbs
Copy link
Contributor

Acribbs commented Nov 25, 2024

oops yes, typo. Have fixed in: #189. All that needs to be done now should be to update documentation and during github actions the documentation is automatically built now.

@Acribbs Acribbs closed this as completed Dec 1, 2024
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

2 participants