Giter Site home page Giter Site logo

Comments (1)

blairconrad avatar blairconrad commented on June 14, 2024

Steps for adding the docs:

  1. check out FakeItEasy (I used master, since its docs have the latest content and the tools for building using material for mkdocs and mike)
  2. ensure the proper python packages are installed (feel free to use a virtual environment):
    pip install --requirement docs/requirements.txt
  3. check out fakeiteasy.github.io
  4. create host-docs branch from upstream/master. Do not switch to it. Stay on master
  5. add the docs
    mike deploy 7.3.1 stable --branch host-docs --prefix docs --update-aliases --config-file ..\FakeItEasy\mkdocs.yml

this will add docs for 7.3.1 with the alias "stable" pointing at them, and commit on the host-analyzer-docs branch

As a bonus:

mike set-default stable --branch host-docs --prefix docs --config-file ..\FakeItEasy\mkdocs.yml

to make "stable" the default branch, so we can visit https://fakeiteasy.github.io/docs

We shouldn't need to "set-default" in the future.

from fakeiteasy.github.io.

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.