Giter Club home page Giter Club logo

brightway-documentation's Introduction

Brightway Documentation (Sphinx/readthedocs.org)

Join the chat at https://gitter.im/brightway-lca/documentation contributions welcome

โ‰๏ธ FAQ

"Where can I find more beginner-friendly documentation?"
The interactive training part of the documentation is at training.brightway.dev.

"How can I contribute to the documentation?"
If you are familiar with Sphinx, you can add your changes to a fork of this repo and open a pull request.
If you would rather get help from a developer, please start a new discussion here. Your suggestions/additions will be added for you.

"Where can I get help beyond the documentation?"
Use the Gitter channel linked above.

โ˜‘๏ธ Instructions

  1. Clone the repository
  2. Install the sphinx Python package and other required packages (themes, etc.). A template conda environment yaml file is provided for convenience at setup/conda_environment.yml
conda env create -f setup/conda_environment.yml
  1. Edit content or add new files
  2. Build the documentation by running, from within the repository root
make html
  1. Preview the documentation by opening
_build/html/index.html

๐Ÿ“š References

Compare the sphinx:

  1. documentation
  2. feature requests queue
  3. discussions on GitHub

Compare the readthedocs.org:

  1. documentation
  2. feature requests queue
  3. discussions on GitHub

brightway-documentation's People

Contributors

michaelweinold avatar shirubana avatar gitter-badger avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.