Skip to content
View WilSalBot's full-sized avatar

Block or report WilSalBot

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Please don't include any personal information such as legal names or email addresses. Maximum 250 characters, markdown supported. This note will be visible to only you.
Report abuse

Contact GitHub support about this user’s behavior. Learn more about reporting abuse.

Report abuse
WilSalBot/README.md

Ubuntu Core documentation

This repository contains the source files to build the Ubuntu Core documentation, which is published here:

https://ubuntu.com/core/docs

The documentation is written in Markdown and built with Sphinx, all taken from the Documentation starter pack_.

Build the documentation

Install prerequisite software


To install the prerequisites:

.. code-block:: none

   make install

This will create a virtual environment (``.sphinx/venv``) and install
dependency software (``.sphinx/requirements.txt``) within it.

View the documentation
~~~~~~~~~~~~~~~~~~~~~~

To view the documentation:

.. code-block:: none

   make run

This will do several things:

* activate the virtual environment
* build the documentation
* serve the documentation on **127.0.0.1:8000**
* rebuild the documentation each time a file is saved
* send a reload page signal to the browser when the documentation is rebuilt

The ``run`` target is therefore very convenient when preparing to submit a
change to the documentation.

.. LINKS
.. _`Documentation starter pack`: https://github.com/canonical/sphinx-docs-starter-pack/tree/main
## Hi there πŸ‘‹

<!--
**WilSalBot/WilSalBot** is a ✨ _special_ ✨ repository because its `README.md` (this file) appears on your GitHub profile.

Here are some ideas to get you started:

- πŸ”­ I’m currently working on ...
- 🌱 I’m currently learning ...
- πŸ‘― I’m looking to collaborate on ...
- πŸ€” I’m looking for help with ...
- πŸ’¬ Ask me about ...
- πŸ“« How to reach me: ...
- πŸ˜„ Pronouns: ...
- ⚑ Fun fact: ...
-->

Popular repositories Loading

  1. Kurotaka-MD Kurotaka-MD Public

    Forked from Eliasar54/Kurotaka-MD

    JavaScript 1

  2. docs docs Public

    Forked from botpress/docs

    Botpress Documentation

    MDX

  3. WilSalBot WilSalBot Public

    Config files for my GitHub profile.

  4. - - Public

  5. ubuntu-core-docs ubuntu-core-docs Public

    Forked from canonical/ubuntu-core-docs

    Documentation for Ubuntu Core systems