question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

improve documentation for building this repo

See original GitHub issue

It 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:closed
  • Created 6 years ago
  • Comments:8 (8 by maintainers)

github_iconTop GitHub Comments

2reactions
ChrisBarker-NOAAcommented, Feb 14, 2018

Shouldn’t that be:

conda install sphinx

😃

0reactions
jakirkhamcommented, Oct 25, 2018

Done in PR ( https://github.com/conda-forge/conda-forge.github.io/pull/540 ). Though further improvements are certainly welcome 😃

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found