improve documentation for building this repo
See original GitHub issueIt would be helpful if the README contained info for building the documentation in this repo locally. Something like:
Contributing
git clone https://github.com/conda-forge/conda-forge.github.io.git
cd conda-forge.github.io
Development environment
install conda
conda install -n root -c conda-forge conda-smithy
Build the documentation
install shpinx
conda install sphinx
Then navigate to the src
directory.
Windows:
./make.bat
UNIX:
make
Build the html for http://conda-forge.org
python scripts/generate_html.py --html-source "."
then navigate to index.html
in the root of your conda-forge.github.io
Issue Analytics
- State:
- Created 6 years ago
- Comments:8 (8 by maintainers)
Top Results From Across the Web
How to Write a Good Documentation: Home
Best Practices for Documenting Your Project · Include a README file that contains · Allow issue tracker for others · Write an API...
Read more >Building Better Documentation Practices for Developers, Part 1
Developers care about docs and will pass up working on an open source project because it lacks good documentation. Learn more.
Read more >Repository documentation guidelines - Bitcraze
Repository documentation guidelines · Development server · Markdown · Files · A page · The menu · URLs and links explained · Github...
Read more >Building documentation
Clone a repository first Before building documentation, you must first clone the repository where the files reside. For the instructions on how to...
Read more >Building repositories from GitHub | Cloud Build Documentation
GitHub triggers enable you to automatically build on Git pushes and pull requests and view your build results on GitHub and Google Cloud...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Shouldn’t that be:
conda install sphinx
😃
Done in PR ( https://github.com/conda-forge/conda-forge.github.io/pull/540 ). Though further improvements are certainly welcome 😃