Giter Club home page Giter Club logo

Comments (3)

amueller avatar amueller commented on May 14, 2024 1

I'll write proper documentation on this later, but for now the process is:

Install hugo and build the hugo part of the site:

sudo apt-get install hugo
cd website
./build_site.sh
rm -rf public/*
hugo

install sphinx and build the sphinx part of the site:

cd sphinx
pip install sphinx sphinx-rtd-theme numpydoc
make

Copy the sphinx part into the hugo part:

cp -r _build/html/ ../public/python_api

The easiest way to push the website that now lives in website/public to github is with

 git worktree add -B gh-pages website/public upstream/gh-pages

If a new class was added, you also need to run the sphinx source generation with

./apidoc.sh

and then reset some files with

git checkout .

easy-peasy!

from mlos.

bpkroth avatar bpkroth commented on May 14, 2024

@amueller this got done in #50 right? I guess #55 is related as well.

from mlos.

bpkroth avatar bpkroth commented on May 14, 2024

This got started in #50. #61 applies some additional fixups and extends it to include link checking as well.

from mlos.

Related Issues (20)

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.