Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

The '-M' commandline option to sphinx-build is not documented. #3751

Closed
bskinn opened this issue May 14, 2017 · 5 comments
Closed

The '-M' commandline option to sphinx-build is not documented. #3751

bskinn opened this issue May 14, 2017 · 5 comments
Labels
api:cmdline good first issue type:docs

Comments

@bskinn
Copy link
Contributor

bskinn commented May 14, 2017 •
edited
Loading

The -M commandline option to sphinx-build, discussed e.g. here under #3196, is not documented on the sphinx-build docs page.

Documentation of -M is also not present on the sphinx-quickstart 'invocation' doc page.
@bskinn
Copy link
Contributor Author

bskinn commented May 14, 2017

@tk0miya I would add the docs entry myself, but I don't think I know enough about its under-the-hood behavior of the option to do a good job of it.

@tk0miya
Copy link
Member

tk0miya commented May 15, 2017

Thank you for post. I will take a look. (I also do not know about the option...)

@dasevilla
Copy link

Some additional resources to help with documenting this

  • make_mode.py has the source code
  • Initial commit message: 91d92be

TimKam added a commit to TimKam/sphinx that referenced this issue Jul 16, 2017
@TimKam
sphinx-doc#3751 document -M command line option
68fe4b2
@TimKam TimKam mentioned this issue Jul 16, 2017
Merged
TimKam added a commit to TimKam/sphinx that referenced this issue Aug 1, 2017
@TimKam
sphinx-doc#3751 work in feedback
6413833
TimKam added a commit to TimKam/sphinx that referenced this issue Aug 22, 2017
@TimKam
sphinx-doc#3751 use double back ticks
ec9f373
tk0miya added a commit that referenced this issue Sep 24, 2017
@tk0miya
Merge pull request #3938 from TimKam/3751-document-m-option
3f1f5bb 
#3751 document -M command line option
@berkerpeksag
Copy link
Contributor

PR #3938 has been merged. This issue can be closed.

@tk0miya tk0miya closed this as completed Nov 11, 2017
@tk0miya
Copy link
Member

tk0miya commented Nov 11, 2017

Right, thanks!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 22, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
api:cmdline good first issue type:docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@berkerpeksag @dasevilla @tk0miya @bskinn