Skip to content

Rewrite configuration doc to be a bit clearer. #404

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

Closed
kasteph wants to merge 1 commit into from
Closed

Rewrite configuration doc to be a bit clearer. #404

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions doc/sphinx/source/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,12 @@

Configuration
=============
You can copy the supplied sample-config to your home directory and move it to
``$XDG_CONFIG_HOME/bpython/config`` [#f1]_. bpython tries to find
``$XDG_CONFIG_HOME/bpython/config`` and use it as its configuration, if the
file does not exist bpython will use its documented defaults.
There is a ``sample-config`` file supplied in your home directory. You can rename it
Copy link
Copy Markdown
Contributor

@sebastinas sebastinas Oct 20, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, this is not correct. The sample-config file is supplied in the bpython directory and can be copied to the home directory.

to ``config`` or copy it and make a new ``config`` file since bpython tries to
find ``$XDG_CONFIG_HOME/bpython/config``(``$XDG_CONFIG_HOME`` defaults to ``~/.config`` if not set)
and use it as its configuration.

.. :: Footnotes

.. [#f1] ``$XDG_CONFIG_HOME`` defaults to ``~/.config`` if not set.
To edit the config file from ``bpython-curtsies``, press ``F3``.

.. include:: configuration-options.rst