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.

Add better documentation for how to build hosted documentation

See original GitHub issue

Copying from another issue ticket, we can improve our static documentation for how to build our generated documentation

The only thing that might be more helpful is updating the instructions a bit under Building documentation with Docker to let contributors know they have to rebuild with the --docs command after changes and the index.html file has to be dragged and dropped into the browser.

_Originally posted by @ari-hacks in https://github.com/arviz-devs/arviz/issues/1155#issuecomment-662350572_

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:1
  • Comments:16 (14 by maintainers)

github_iconTop GitHub Comments

1reaction
OriolAbrilcommented, Oct 23, 2020

I think we can do it in the same PR, but I don’t have strong preferences on this

1reaction
OriolAbrilcommented, Oct 22, 2020

Maybe its due to the doc reorganizations thinking I’ll check

Indeed, https://github.com/arviz-devs/arviz/blob/master/scripts/container.sh#L38 should be:

"if [ -d ./doc/build ]; then python -msphinx -M clean doc/source doc/build; fi && sphinx-build doc/source doc/build -b html"

The conf.py file used to be on doc/ but was moved to doc/source so now it’s not found anymore by the script because it’s still looking at the old location.

Azure CI script was updated https://github.com/arviz-devs/arviz/blob/master/.azure-pipelines/azure-pipelines-docs.yml#L60-L61 and can serve as an example to compare against when things don’t work

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to Write a Good Documentation: Home
How to Write a Good Documentation: Home. This guide will help you to prepare your code for publishing through writing a good documentation....
Read more >
How to Build the Best User Documentation (New Guide) | Blog
Start with the easy stuff first and then, as your users build their knowledge, show them the advanced features.
Read more >
Building better documentation | Atlassian
The best documentation lets you hit the ground running. Learn how to create engaging & informative documentation using our easy, 6 step guide....
Read more >
How to Create and Manage Technical Documentation Faster
Best practices for technical documentation templates · Think about design. · Make template use straightforward and use appropriate version control. · Create it ......
Read more >
Documentation 101: 5 Tools to Help You Create Better Docs
Its getting started guide is all you need to know to start writing documentation without needing to think about hosting servers or the ......
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