Create a documentation webpage

[hot9cups]

Create a documentation webpage and host it on a free hosting servive(prefer github).

Most of the functionalities of code are documented here so all that needs to be done now is transform that to a webpage and host it on github.

[basil08]

Is there any particular theme you prefer? For example: something from the GitHub pages themes or I can a suitable one.

Also, is the linked usage.md the only material to put on the webpage or class documentation also (similar to pydocs)?

[hot9cups]

@basil08 Hm, I can't seem to think of a particular theme at the moment, so I'm open to your suggestions :)

Also definitely, I'd like the documentation to resemble pydocs. Therefore do go ahead and include the class documentation too!

What I meant in the issue above was that Usage.md was the bare minimum and a great starting point for anyone looking to work on this. You are most welcome and appreciated to go ahead and improvise :)

[hot9cups]

@basil08 I finally got some time to go through the github pages themes.

There were two of them I particularly liked: 1)hacker 2)leap-day

I think I like leap-day a little more because of the professional look. I hope this helps give you a kickstart :)

[basil08]

Ok, I have messed up my local repo very badly and can't even push to my fork. Also, I'll be getting busy this week. So, it would be nice if you can assign this to someone else. I don't want to hinder work aimlessly.

[hot9cups]

I suppose you could delete the fork and get a new one.

Unassigned, this issue is now open to everyone!

Also in case no-one takes it up, feel free to come back, basil, whenever you like and continue working :)

[mihir1739]

Hello Sir ! I would like to work on this . Please assign me this

[hot9cups]

@mihir1739 assigned ! Feel free to discuss your plans before beginning work on it :)

[mihir1739]

Yes Sir, thanks for the assignment. So my plan is as following. ->overview ->Download and Setup ->Documentation ->Class wise documentation (with demo plots) ->Code(leading to Github Repo) ->About ( linking to probdists page) please suggest changes wherever you feel necessary.

[saeyma]

Hi @mihir1739, are you working on this? If not anymore, can I?

[mihir1739]

@saeyma yeah please....I am kinda busy now

[basil08]

@hot9cups, I would like to work on this.

On Fri, 8 Oct, 2021, 09:07 Mihir Kumar Singh, @.***> wrote:

@saeyma https://github.com/saeyma yeah please....I am kinda busy now

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/hot9cups/probdists/issues/4#issuecomment-938312284, or unsubscribe https://github.com/notifications/unsubscribe-auth/AN6GOB6TLRS5ZLBH6LOPW3LUFZRO7ANCNFSM4S7E32TA . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

[hot9cups]

@saeyma sure thing, assigned :)

[hot9cups]

@basil08 nice to see you again, been a whole year :) I'm assigning this on a first-come basis so saeyma gets it this time. Sorry :(

[saeyma]

@hot9cups, I have completed documentation webpage for two classes. Would like you to take a look. If you're happy, I can proceed further. Here is the link: https://saeyma.github.io/probdists I have used jekyll-leap-year-theme after reading previous discussions.

[hot9cups]

@saeyma this is so much better than what I had in mind, great job! If you'd like to create a PR right now, go ahead; I can add the hacktoberfest-accepted label so it starts counting towards your tally immediately and you can continue to work on it peacefully then :)

[saeyma]

yes, sounds good. :+1:

[saeyma]

@hot9cups should I open a PR against your main branch (not a good idea)? I think you should create a gh-pages branch.

[hot9cups]

@saeyma well right now I'm using static files served inside /docs, so the content there should be showing up here - https://hot9cups.github.io/probdists/

[saeyma]

@hot9cups um ok, I'm opening against main then. You can merge into a diff branch later as you wish.

[saeyma]

Basically, I can't do it against main as these two branches have different commit histories. Any ideas?