Conda-forge.github.io: Update the Build Procedure in README.md

[prachi237]

As a first time contributor to the Conda-forge, the contributor would be reading the Build Procedure in Readme.md file, at first. Hence the steps that are to be taken to set the project in the local environment as well as to do lists before sending the PR should be mentioned clearly.

clear steps/tutorial links can be provided to let the contributor know how to get familiar with sphinx. For example:
sphinx Docs

This can be followed by steps mentioned above. In addition before sending PR the contributor should check the changes made in src folder works well by verifying the docs file in their local directory.

(open command prompt=> sphinx-build . ../docs =>auto generated html file in docs folder can be found)

These steps are not mentioned below:

[prachi237]

@beckermr and @viniciusdc what do u think about this? shall I add these steps that I mentioned above to make the docs more user-friendly.

[beckermr]

Yes please!

[prachi237]

@viniciusdc can u assign me with this issue and add labels.😄

[angeloobeta]

@prachi237
I can see that the README.md file hasn't been merged; there are more features I would like to add to the README.md file after you have added the changes you mentioned in the comment above.

@viniciusdc
Please just as @prachi237 stated, the ease and flexibility that the README.md file communicates the necessary information to the first time contributor is of very paramount importance. To that effect, I would like to add a requirements.txt file (sphinx, cloud_sptheme, recommonmark, cloud_sptheme, sphinx-rtd-theme, sphinxcontrib-fulltoc (conda install sphinx sphinxcontrib-fulltoc), images describing the console output during setup.

The requirements.txt file would be located in the src folder. the packages will contain the necessary packages and libraries and some image describing the output of the console during the setup process. This would enable the contributors to always be up till date with the package versions that should be used for building the documentation. This would go along way to avoid conflicts during building process.

[angeloobeta]

@viniciusdc should I go ahead with it

[prachi237]

@viniciusdc should I go ahead with it

I too wanted to add installation process of sphinx and necessary set up in fact earlier I had added the tutorial links for that but sir told that was not necessary, he asked me to delete those lines. instead we can link this up (https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html) to keep th readme.md file brief.

[angeloobeta]

@PrernaSingh587
Wooow, Thanks for the feedback. Ok your explanation is very clear, no doubt using the link is going to make it README.md file to be concise. If you add only the above link without adding other links for setup like recommonmark in the README.md, a first contributor might not locate the necessary packages.

[viniciusdc]

@PrernaSingh587
Wooow, Thanks for the feedback. Ok your explanation is very clear, no doubt using the link is going to make it README.md file to be concise. If you add only the above link without adding other links for setup like recommonmark in the README.md, a first contributor might not locate the necessary packages.

Hi @angeloobeta thanks for you comments, for the requirements we already have an environment.yaml file, I am not sure if it helps you 🤔

[angeloobeta]

☺️ ☺️
Your explanation was very useful, I didn't look into the direction of the environment.yaml
Thank you for explaining.