Giter VIP home page Giter VIP logo

docsbuild-scripts's Introduction

This repository contains scripts for automatically building the Python documentation on docs.python.org.

How to test it?

$ mkdir -p www logs build_root
$ python3 -m venv build_root/venv/
$ build_root/venv/bin/python -m pip install -r requirements.txt
$ python3 ./build_docs.py --quick --build-root build_root --www-root www --log-directory logs --group $(id -g) --skip-cache-invalidation

Check current version

Install tools-requirements.txt then run python check_versions.py ../cpython/ (pointing to a real cpython clone) to see which version of Sphinx we're using where::

Docs build server is configured to use sphinx==2.2.1

Sphinx configuration in various branches:

========  =============  =============  ==================  ====================  =============  ===============
branch    travis         azure          requirements.txt    conf.py               Makefile       Mac installer
========  =============  =============  ==================  ====================  =============  ===============
2.7       sphinx~=2.0.1  ø              ø                   needs_sphinx='1.2'
3.6       sphinx==1.8.2  sphinx==1.8.2  ø                   needs_sphinx='1.2'
3.7       sphinx==1.8.2  sphinx==1.8.2  ø                   needs_sphinx="1.6.6"
3.8       sphinx==1.8.2  sphinx==1.8.2  ø                   needs_sphinx='1.8'                   Sphinx==2.0.1
master    sphinx==2.2.0  sphinx==2.2.0  sphinx==2.2.0       needs_sphinx='1.8'    Sphinx==2.2.0  Sphinx==2.2.0
========  =============  =============  ==================  ====================  =============  ===============

Sphinx build as seen on docs.python.org:

========  =====  =====  =====  =====  =======  =======  =======  =====
  branch  en     fr     ja     ko     pt-br    zh-cn    zh-tw    id
========  =====  =====  =====  =====  =======  =======  =======  =====
     2.7  2.2.1  2.2.1  2.2.1  2.2.1  2.2.1    2.2.1    2.2.1    2.2.1
     3.6  2.2.1  2.2.1  2.2.1  2.2.1  2.2.1    2.2.1    2.2.1    2.2.1
     3.7  2.2.1  2.2.1  2.2.1  2.2.1  2.2.1    2.2.1    2.2.1    2.2.1
     3.8  2.2.1  2.2.1  2.2.1  2.2.1  2.2.1    2.2.1    2.2.1    2.2.1
     3.9  2.2.1  2.2.1  2.2.1  2.2.1  2.2.1    2.2.1    2.2.1    2.2.1
========  =====  =====  =====  =====  =======  =======  =======  =====

docsbuild-scripts's People

Contributors

benjaminp avatar berkerpeksag avatar birkenfeld avatar dstufft avatar ewdurbin avatar julienpalard avatar kushaldas avatar ned-deily avatar oonid avatar zhsj avatar zware avatar

Watchers

 avatar

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.