Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
_static
_static
 
 
_templates
_templates
 
 
api
api
 
 
static
static
 
 
tutorials
tutorials
 
 
whats_new
whats_new
 
 
.gitignore
.gitignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
api.rst
api.rst
 
 
build.yml
build.yml
 
 
build_doc.sh
build_doc.sh
 
 
build_pip_install.sh
build_pip_install.sh
 
 
cheatsheet.md
cheatsheet.md
 
 
conf.py
conf.py
 
 
index.md
index.md
 
 
install-conda-full.md
install-conda-full.md
 
 
install-cpu-pip.md
install-cpu-pip.md
 
 
install-cpu-source.md
install-cpu-source.md
 
 
install-gpu-pip.md
install-gpu-pip.md
 
 
install-gpu-source.md
install-gpu-source.md
 
 
install-mac-cpu-source.md
install-mac-cpu-source.md
 
 
install-mac-cpu.md
install-mac-cpu.md
 
 
install-mac-libomp.md
install-mac-libomp.md
 
 
install-mac-nogpu.md
install-mac-nogpu.md
 
 
install-modules.md
install-modules.md
 
 
install-windows-conda-gpu.md
install-windows-conda-gpu.md
 
 
install-windows-cpu.md
install-windows-cpu.md
 
 
install-windows-generic.md
install-windows-generic.md
 
 
install-windows-gpu.md
install-windows-gpu.md
 
 
install.md
install.md
 
 
requirements_doc.txt
requirements_doc.txt
 
 
versions.rst
versions.rst
 
 

README.md

How to perform a new release

Refer to release_instructions/ReleaseInstructions.md

How to locally build AutoGluon docs

Instructions apply to Linux and Mac. Windows has not been tested for doc builds.

Ensure you have a local AutoGluon install for development. If not run the following in package root:

pip install -U pip wheel
./full_install.sh

Then run in package root:

cd docs/
python3 -m pip install -r requirements_doc.txt

Now you are ready to run the doc build:

# Note: GPU & CUDA is required to build tutorials
# To skip running tutorials, manually edit `docs/conf.py` and set `nb_execution_mode=off`
bash build_doc.sh