Lines Matching +full:build +full:- +full:docs
1 # rules_python Sphinx docs generation
3 The docs for rules_python are generated using a combination of Sphinx, Bazel,
6 MyST-specific Markdown functionality.
11 Manually building the docs isn't necessary -- readthedocs.org will
12 automatically build and deploy them when commits are pushed to the repo.
14 ## Generating docs for development
16 Generating docs for development is a two-part process: starting a local HTTP
17 server to serve the generated HTML, and re-generating the HTML when sources
21 bazel run //docs:docs.serve # Run in separate terminal
22 ibazel build //docs:docs # Automatically rebuilds docs
25 This will build the docs and start a local webserver at http://localhost:8000
27 changes and re-run the build process, and you can simply refresh your browser to
33 The `ibazel` tool can be used to automatically rebuild the docs as you
34 development them. See the [ibazel docs](https://github.com/bazelbuild/bazel-watcher) for
39 sudo npm install -g @bazel/ibazel
50 `docs/conf.py`. For more info, see https://myst-parser.readthedocs.io.
54 The Sphinx-specific configuration files and input doc files live in
55 docs/.
57 The Sphinx configuration is `docs/conf.py`. See
58 https://www.sphinx-doc.org/ for details about the configuration file.
65 the OS version used to build, Python version, dependencies, what Bazel
67 * https://readthedocs.org/projects/rules-python: This is the project
72 For more readthedocs configuration details, see docs.readthedocs.io.