Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 1.04 KB

Update_documentation.md

File metadata and controls

48 lines (31 loc) · 1.04 KB

Guidelines to update the documentation

Getting Started

Prerequisites

  1. Python and pip: Ensure Python and pip are installed. Verify your installation by running:

    python --version
    pip --version
  2. Conda: Install Anaconda or Miniconda. Download from Anaconda or Miniconda.

Installation

  1. Clone the repository:

    git clone [email protected]:Bio2Byte/gpcrchimeradb-docs.git
    cd gpcrchimeradb-docs
  2. Create a new conda environment with Python 3:

    conda create --name gpcrchimeradb-docs python=3
    conda activate gpcrchimeradb-docs
  3. Install the required packages:

    cd docs
    pip install -r requirements.txt

Building the Documentation

  1. Build the HTML documentation using the make command:

    make html
  2. Add, commit, and push the changes. After about a minute, the updates will be visible on the web server!