From 72a1bc54ea0a82eabd67c6cde602280bf7970881 Mon Sep 17 00:00:00 2001 From: Emmanuel Florent Date: Fri, 28 Jun 2019 11:34:12 +0200 Subject: [PATCH 1/2] Update README --- README.md | 22 ++-------------------- layouts/_default/baseof.html | 2 +- 2 files changed, 3 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index bc30f33..4a5af1e 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,4 @@ -<<<<<<< HEAD -# At this moment deprecated in favor of pydocs. - -This project is based on Gitbook, new docs are based on Github pages. - -# Introduction -======= # run locally ->>>>>>> publish ``` brew install hugo @@ -15,19 +7,9 @@ hugo serve # Workflow -<<<<<<< HEAD -* [Products](products.md) -* [Getting Started](getting-started/introduction.md) -* [Pymakr](pymakr-plugin/installation/) -* [Tutorials](tutorials-and-examples/introduction.md) -* [API Documentation](firmware-and-api-reference/introduction.md) -* [Product Info](product-info-datasheets/introduction.md) -* [Pybytes](pybytes/introduction.md) -======= - Make PR using Master branch - PR get merged on master - Then merge publish with master ->>>>>>> publish ``` git commit -m "section: commit message" @@ -55,5 +37,5 @@ git push origin publish wget -o 404.txt -r --spider http://localhost:1313 ``` -A webhook has been installed on the publish branch to: -- https://publish.d1rmdw1xyxqk1e.amplifyapp.com/ +A webhook has been installed on the publish branch to +https://github.com/pycom/pycom-documentation/tree/master diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index 13839ef..6101859 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -56,8 +56,8 @@ drawer2: true, toc: 0, branches: [ - { value: 'https://docs.pycom.io', text: 'version stable', }, { value: 'https://development.pycom.io', text: 'version development'}, + { value: 'https://docs.pycom.io', text: 'version stable', }, ], branch: "" }, From 6d96d81d53f3445d28926d55a78e88479847b46e Mon Sep 17 00:00:00 2001 From: Emmanuel Florent Date: Fri, 28 Jun 2019 13:44:41 +0200 Subject: [PATCH 2/2] disable breadcumbs at first level --- content/_index.md | 1 + content/datasheets/_index.md | 1 + content/docnotes/_index.md | 2 +- content/firmwareapi/_index.md | 2 +- content/gettingstarted/_index.md | 2 ++ content/products.md | 1 + content/pybytes/_index.md | 1 + content/pytrackpysense/_index.md | 2 +- content/tutorials/_index.md | 2 +- layouts/_default/list.html | 4 +++- layouts/_default/single.html | 2 ++ 11 files changed, 15 insertions(+), 5 deletions(-) diff --git a/content/_index.md b/content/_index.md index 88293de..a58500f 100644 --- a/content/_index.md +++ b/content/_index.md @@ -2,6 +2,7 @@ title: "Introduction" aliases: - /introduction +disable_breadcrumbs: true --- Welcome to the Pycom documentation site. We recommend reading through all the sections to familiarise yourself with the various tools and features available to you to help you develop on your Pycom module. diff --git a/content/datasheets/_index.md b/content/datasheets/_index.md index 6ed1d0f..efd3a1e 100644 --- a/content/datasheets/_index.md +++ b/content/datasheets/_index.md @@ -6,6 +6,7 @@ aliases: - datasheets/introduction - product-info - chapter/datasheets +disable_breadcrumbs: true --- The follow pages contain all information relating to each product, for examples: pinouts, spec sheets, relevant examples and notes. diff --git a/content/docnotes/_index.md b/content/docnotes/_index.md index 56ceaa4..6e9a909 100644 --- a/content/docnotes/_index.md +++ b/content/docnotes/_index.md @@ -1,6 +1,6 @@ --- title: "" aliases: +disable_breadcrumbs: true --- The Pycom documentation aims to be straightforward and to adhere to typical Python documentation to allow for ease of understanding. However, there may be some unusual features for those not used to Python documentation or that are new to the MicroPython Language. This section of the documentation aims to provide clarity for any of the design specifics that might be confusing for those new to Python and this style of documentation. - diff --git a/content/firmwareapi/_index.md b/content/firmwareapi/_index.md index 6ff8887..19e32ef 100644 --- a/content/firmwareapi/_index.md +++ b/content/firmwareapi/_index.md @@ -1,6 +1,7 @@ --- title: "" aliases: +disable_breadcrumbs: true --- This chapter describes modules (function and class libraries) that are built into MicroPython. There are a number of categories for the available modules: @@ -14,4 +15,3 @@ This chapter describes modules (function and class libraries) that are built int This documentation in general aspires to describe all modules and functions/classes which are implemented in MicroPython. However, MicroPython is highly configurable, and each port to a particular board/embedded system makes available only a subset of MicroPython libraries. For officially supported ports, there is an effort to either filter out non-applicable items, or mark individual descriptions with “Availability:” clauses describing which ports provide a given feature. With that in mind, please still be warned that some functions/classes in a module (or even the entire module) described in this documentation may be unavailable in a particular build of MicroPython on a particular board. The best place to find general information of the availability/non-availability of a particular feature is the “General Information” section which contains information pertaining to a specific port. Beyond the built-in libraries described in this documentation, many more modules from the Python standard library, as well as further MicroPython extensions to it, can be found in the [micropython-lib](https://github.com/micropython/micropython-lib) repository. - diff --git a/content/gettingstarted/_index.md b/content/gettingstarted/_index.md index fe1ff9e..e67199f 100644 --- a/content/gettingstarted/_index.md +++ b/content/gettingstarted/_index.md @@ -9,6 +9,8 @@ aliases: - gettingstarted - getting-started/introduction - chapter/gettingstarted/introduction + +disable_breadcrumbs: true --- So, you've decided to order a Pycom development module. Firstly we would like to congratulate you in making an excellent decision. If you haven't yet placed your order we highly recommend you check out the [products](/products) page before you place your order to ensure you know which accessories you might require. diff --git a/content/products.md b/content/products.md index 5481b8f..fc607b3 100644 --- a/content/products.md +++ b/content/products.md @@ -4,6 +4,7 @@ aliases: - products.html - products.md - chapter/products +disable_breadcrumbs: true --- ## Pycom Products diff --git a/content/pybytes/_index.md b/content/pybytes/_index.md index 9af1012..196994c 100644 --- a/content/pybytes/_index.md +++ b/content/pybytes/_index.md @@ -2,6 +2,7 @@ title: "" aliases: - pybytes/introduction +disable_breadcrumbs: true --- [![pybytes](/gitbook/assets/pybytes/introduction/pybytes_logo.png)](https://pybytes.pycom.io/?utm_source=docs&utm_medium=web&utm_campaign=pybytes-introduction) diff --git a/content/pytrackpysense/_index.md b/content/pytrackpysense/_index.md index e24878f..a865d2f 100644 --- a/content/pytrackpysense/_index.md +++ b/content/pytrackpysense/_index.md @@ -1,6 +1,7 @@ --- title: "" aliases: +disable_breadcrumbs: true --- In addition to the Expansion Board, Pycom also offers three additional sensor boards, which are ideal for quickly building a fully functioning IoT solution! Whether the application is environment sensing or asset tracking, these additional boards support a variety of sensors. @@ -74,4 +75,3 @@ All of the included sensors are connected to the Pycom device via the I2C interf You can find the datasheet and more info here: {{% refname "../datasheets/boards/pyscan.md" %}} - diff --git a/content/tutorials/_index.md b/content/tutorials/_index.md index b59d1cf..2aeb72b 100644 --- a/content/tutorials/_index.md +++ b/content/tutorials/_index.md @@ -1,6 +1,7 @@ --- title: "" aliases: +disable_breadcrumbs: true --- ![](/gitbook/assets/tutorialsicon%20%281%29.png) @@ -14,4 +15,3 @@ General Pycom tutorials contains tutorials that may be run on any Pycom device, Before starting, ensure that any Pycom devices are running the latest firmware; for instructions see [Firmware Updates](/gettingstarted/installation/firmwaretool). The source code for these tutorials, along with the required libraries can be found in in the [pycom-libraries](https://github.com/pycom/pycom-libraries) repository. - diff --git a/layouts/_default/list.html b/layouts/_default/list.html index 3af4b64..4364a20 100644 --- a/layouts/_default/list.html +++ b/layouts/_default/list.html @@ -1,7 +1,9 @@ {{ define "main" }} - {{ partial "breadcrumb_recursive.html" (dict "menu" .Site.Menus.main "page" . ) }} + {{ if not .Params.disable_breadcrumbs }} + {{ partial "breadcrumb_recursive.html" (dict "menu" .Site.Menus.main "page" . ) }} + {{ end }}

{{- .Title -}}

{{- .Content -}}
    diff --git a/layouts/_default/single.html b/layouts/_default/single.html index bc685ea..5cb96b6 100644 --- a/layouts/_default/single.html +++ b/layouts/_default/single.html @@ -1,7 +1,9 @@ {{ define "main" }} + {{ if not .Params.disable_breadcrumbs }} {{ partial "breadcrumb_recursive.html" (dict "menu" .Site.Menus.main "page" . ) }} + {{ end }}

    {{- .Title -}}

    {{- .Content -}}