Giter Club home page Giter Club logo

Comments (5)

Gustavo-SF avatar Gustavo-SF commented on July 20, 2024 3

I also had this same issue on macOS 12.4, Python3.10 and mkdocs-click version 0.8.0.
Fixed it with a double newline at the end.

from mkdocs-click.

ofek avatar ofek commented on July 20, 2024

I think part of the issue is that h1 is set as the CLI's name. Can you try :depth: 1 or removing header?

from mkdocs-click.

ieaves avatar ieaves commented on July 20, 2024

Hey @ofek. Sure! Here are a few of the variations I've attempted based on your suggestion

  • Changing the h1 label (just to test in this case), one space at the end of the file, with and without :depth: 1 tag
  • Removing the header, one space at the end of the file, with and without :depth: 1 tag

None of those work, however, they all work if there are two spaces at the end of the file.

EDIT: I can also add, the issue was identical for me in two different environments, one arch linux and the other macOS.

Double edit: It also works with a newline + space or newline + tab.

from mkdocs-click.

sveint avatar sveint commented on July 20, 2024

I can confirm the issue.

I thought something was misconfigured, but then I found this issue and thought I'd try it out. For me a single newline with no extra characters fixes the problem.

from mkdocs-click.

matroscoe avatar matroscoe commented on July 20, 2024

I also ran into this issue, if it is required (it is really okay that it is) ideally there would be a check for this at build time (or a note in the README). I spent a fair amount of time banging my head against a wall to find out why I couldn't get my docs to generate.

Python 3.11, Ubuntu 22.04, mkdocs-click = "^0.8.0"

from mkdocs-click.

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.