search

mpusz / mp-units

The quantities and units library for C++
https://mpusz.github.io/mp-units/
MIT License
1.07k stars 85 forks source link

No docs for older Library versions #498

Closed WBurzynski closed 4 months ago

WBurzynski commented 1 year ago

Github pages contain only documentation for 2.0 and 2.1. Old documentation page does not work.

mpusz commented 1 year ago

Yes, that is unfortunate 😢 As we changed the documentation framework from Sphinx to mkdocs, I was unable to force mkdocs to present old docs properly (with CSS styles being used). I am unfortunately not a good web developer... 😉

If someone knows how to attach Sphinx-generated docs to mkdocs then please do not hesitate to contact me and we will expose old docs right away.

WBurzynski commented 1 year ago

as a workaround maybe you can set up secondary repo with just the docs?

mpusz commented 1 year ago

I can try to do it when I have a bit of free time. However, the expectation is that the old version will not be maintained anymore, and the developers should migrate to a new version as soon as possible. The docs for the old version are in the sources and can be easily built by anyone interested.

yahya-mohammed07 commented 12 months ago

I would like to work on this and fix this, any starting tips?

mpusz commented 12 months ago

Awesome! Please find the snapshot of the latest docs for mp-units 0.8 attached. It would be great if it could be somehow attached to the current mk-docs.

The instructions to build current docs can be found here: https://mpusz.github.io/mp-units/2.1/getting_started/installation_and_usage/#building-documentation.

mp-units-docs-0.8.zip

i-ky commented 12 months ago

Please find the snapshot of the latest docs for mp-units 0.8 attached. It would be great if it could be somehow attached to the current mk-docs.

I guess you can upload it as a release asset. In my opinion this would be the next best place to serve the generated documentation.

mpusz commented 12 months ago

I guess you can upload it as a release asset. In my opinion this would be the next best place to serve the generated documentation.

Good idea. However, it seems I do not know how to do that :-(

Is it possible to do it from the web interface, or do I have to somehow figure out how the REST API works?

i-ky commented 12 months ago

I guess you can upload it as a release asset. In my opinion this would be the next best place to serve the generated documentation.

Good idea. However, it seems I do not know how to do that :-(

Is it possible to do it from the web interface, or do I have to somehow figure out how the REST API works?

Use the release editing web interface, there should be an interface to upload an asset manually. Here is how it looks for one of my repos: image

P.S. There is nothing to be ashamed of, if you don't know this corner of GitHub's UI. I happen to know this only because I was too lazy to automate the release process and ended up compiling and uploading binaries manually. :)

mpusz commented 12 months ago

Done! The docs for the V1 can be found here: https://github.com/mpusz/mp-units/releases/tag/v0.8.0.

Thanks @i-ky!

mpusz commented 12 months ago

@yahya-mohammed07, in order to have different versions of the docs we use mike. You can find all the information here: https://github.com/jimporter/mike.

mpusz commented 4 months ago

@yahya-mohammed07 are you still working on it? If not, can we close this issue?

yahya-mohammed07 commented 4 months ago

@yahya-mohammed07 are you still working on it? If not, can we close this issue?

Yeah close it please, sorry for being late