search

2Max4 / Network_Analysis

Collection of useful scripts to analyse the local network and evaluate network speed and velocity
MIT License
2 stars 11 forks source link

Create readthedocs documentation #28

Open 2Max4 opened 5 years ago

2Max4 commented 5 years ago

Use readthedocs to generate a more advanced dokumentation of the existing projects in order to get new contributors an easy start on the project.

Rho-n commented 5 years ago

I created an account on readthedocs with the username network_analysis. I wasn't sure how you connect the hooks, but you need to allow access to your github account. I can switch the email for this readthedocs account and turn it over to you (2Max4), or I can delete the account and you can signup on readthedocs with your github account. I am happy to keep working on getting things automated, just not sure the best way to set things up with shared access.

2Max4 commented 5 years ago

Hey @Rho-n so did I get it right, that only the owner of the repo can "link" repo and the documentation?

If that was the case the best version would be that you delete the account and I try to set it up by myself.

Is there any other work that can be done in order to get things working. Maybe some kind of markup that tells readrhedocs how to structure and interpret things?

Rho-n commented 5 years ago

Hi @2Max4, it appears I would need certain access to the 2Max4/Network_Analysis repository so that readthedocs can connect through my github account for me to set things up. The biggest thing it needs is access to the github webhooks for the repository, so it can build on change.

See: https://docs.readthedocs.io/en/stable/connected-accounts.html

Rho-n commented 5 years ago

@2Max4 I set up a test in readthedocs for my fork of network_analysis, it appears once you have the project imported/connected to your readthedocs account you can assign maintainers. To clarify, I have deleted the network_analysis account on readthedocs, and created a new one using my github credentials.

2Max4 commented 5 years ago

@Rho-n thanks for the research! I'll check it out and let you know asap!

2Max4 commented 5 years ago

@Rho-n I've added you as a developer - I hope that everything is working now :D

I had to use the name Network Analysis Toolkit since the original name was not free yet.

Rho-n commented 5 years ago

@2Max4 I have deleted all the various projects I created on readthedocs with references to network_analysis. Hopefully the namespace issue will clear up. I will look into it if it doesn't.

2Max4 commented 5 years ago

@Rho-n no needs to worry! I am totally fine with the current name :)

Rho-n commented 5 years ago

I think this issue can be closed. Perhaps open another, if help updating the docs is needed.

2Max4 commented 5 years ago

@Rho-n Thanks for your help!

Do you have any further ideas how we can develop the documentation further on? Are there any other tasks you want to work on? Creating Docstrings eg. would be verry helpfull!

Greetings Max

Rho-n commented 5 years ago

@2Max4 I have been thinking about translations, both in the code and for the documentation. I have read some of the documentation on readthedocs on how they support them. It looks like Docstrings are used.

2Max4 commented 5 years ago

If Docstrings are used - perfect! We still have to improve on them!