47 Commits

Author SHA1 Message Date
Czapla
69615e1f0f
Remove version number from Windows (#1047)
Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>
2021-09-01 13:15:59 +02:00
dgorti
bdc7adfc99
Update development_environment.md (#1044)
On a fresh WSL2 install of Ubuntu, sudo apt-get update must be run first. Otherwise the packages are not found.
This may be second nature to Linux devs, but for freshly minted WSL2 devs, this might not be known
2021-08-31 13:39:44 +01:00
AustinRaney-NOAA
5efc820ef2
Bump python dev version in docs to 3.8 b.c. home-assistant/core#50013 (#977)
Usage of `typing.Final` added in [50013](https://github.com/home-assistant/core/pull/50013), specifically, (076227acbe/homeassistant/const.py (L4)) is only supported in python 3.8+.
See: https://docs.python.org/3.8/library/typing.html#typing.Final
2021-06-22 19:35:58 +02:00
Farid
5401141431
Update development_environment.md (#941) 2021-05-16 15:11:08 +01:00
peddamat
42089e7252
Added link to Home Assistant core repository (#920) 2021-05-09 19:35:36 +02:00
Jan Bouwhuis
20b46c7d4a
Windows performance devcontainer note (#895) 2021-04-23 18:21:08 +02:00
Erik Montnemery
1dc5528400
Add note for Windows about turning WSL off, then back on again (#793)
* Add note for WSL about turning the computer off, then back on again

* Update docs/development_environment.md

Co-authored-by: Tom Brien <TomBrien@users.noreply.github.com>

* Update development_environment.md

* Update docs/development_environment.md

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

* Tip was too big, remove it

* Update development_environment.md

* Apply suggestions from code review

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

* Update development_environment.md

* Update development_environment.md

* Update development_environment.md

Co-authored-by: Tom Brien <TomBrien@users.noreply.github.com>
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
2021-03-16 16:48:26 +01:00
Sam Welek
e47096e7d5
Fixes some Typos in the Documentation (#678)
* Fixing typo on development_enviornment.md

* Fixing various typos throughout the docs, it's not much but it's honest work
2020-10-11 15:47:52 +01:00
Markus Bong
21ee6f9492
Fix Typo in Setup Local Repository (#664) 2020-10-02 10:48:07 +02:00
Paulus Schoutsen
0ace6189dc
Streamline setting up dev env (#588)
Co-authored-by: Franck Nijhof <git@frenck.dev>
2020-06-25 11:39:47 -07:00
Kevin Eifinger
3cbe2294ed
Add instructions to update ffmpeg on Ubuntu 18.04 (#553) 2020-05-27 21:47:12 +02:00
Kevin Eifinger
7a64a0b1ea
Change instructions mentioning python3.x to python3 (#554)
* Change python3.x to python3
2020-05-26 11:37:39 +01:00
Tom Brien
b4a2599750
Update WSL IP address steps (#555) 2020-05-25 14:21:20 +02:00
Tom Brien
12348dcbc4
Add steps for loading instance in WSL (#543) 2020-05-18 12:15:52 +02:00
Jeff Rescignano
610c98fec9
Update "Frontend" URL on "Set up Development Environment" page (#534) 2020-05-17 15:31:00 +02:00
Jeff Rescignano
3d5b5e592b
Update the WSL 2 URL in docs/development_environment (#524) 2020-05-13 01:20:32 +02:00
Tom Brien
ef82fe7149
Update Docker requirements (#467) 2020-04-21 17:02:21 -07:00
Erik Montnemery
265cce2eb3
pallet -> palette (#464) 2020-04-14 11:04:53 -07:00
Tom Brien
d6e06a716d
Replace quotes with tip boxes (#458)
* Replace quotes with tip boxes

The use of quotes was making important content less clear than the body. Docusaurus now has native tip boxes use remark-admonitions so use these instead.

* Replace json5 codeblock language with json

json5 doesn't have native syntax colouring. Rather than handle with custom css just flip block to have `json` set as language to create same result. All blocks were standard JSON anyway
2020-04-04 14:32:57 -07:00
Paulus Schoutsen
5bc46ac6d0
Promote dev containers more in dev env docs (#453) 2020-04-02 16:36:05 -07:00
Gerard
ff31df7c20
Another home-assistant to core change (#450) 2020-03-31 16:37:58 -07:00
Gerard
7f9f4e95a7
Directory change from home-assistant to core (#449) 2020-03-31 16:03:05 -07:00
Viktor Lindgren
eed4674fb0
Updated the Fork instruction and shell command (#441)
* Updated the Fork instruction and shell command

Im not sure but i believe since the name change into core and the other homeassistant version the fork instruction is faulty. So i changed it and added a small little note, which might be a little overkill.

* ✏️ Tweaks

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
2020-03-18 22:48:07 +01:00
Ville Skyttä
770185004b
Code block improvements (#382)
* Use f-strings instead of .format()

* Code block language marker fixes

* Make example code blocks syntactically valid Python

* Run all python code blocks through black

https://github.com/scop/misc/blob/master/black_markdown.py

* Add some missing code block language markers

* Use shell language consistently to mark shell code blocks

* Undo folding of some example dicts

* Remove outdated OrderedDict comments per Python 3.7, replace with plain dict
2020-01-13 21:55:41 +02:00
Shawn Wilsher
5cd498d1dc Update Developement Environment Docs for Windows (#374)
I was following the instructions, but they don't work at all for Windows.  Issues fixed:
* The old command would use python3.6, but home assistant requires 3.7
* Picks up the change in https://github.com/home-assistant/developers.home-assistant/pull/335 for the Windows section.
* Explicitly use 3.7 when setting up the venv, since on some systems `python3` points to 3.6, not 3.7
2020-01-02 13:14:27 +01:00
Stefan Agner
eef570153a Update development_environment.md (#376)
Add hint if command 'remote-containers.reopenInContainer' not found is shown.
2020-01-02 13:12:56 +01:00
RonSpawnson
415a291951 Update development_environment.md (#372)
Previous wording had a grammatical error ("Due to Home Assistant is"). I have proposed a small alteration to resolve this.
2019-12-28 10:04:01 +01:00
Kit Klein
41c7defebc Clarify project location in WSL (#327)
`script/setup` will fail due to a path permissions issue if you do not clone the project to a location within the WSL filesytem.
2019-10-02 20:08:59 -07:00
Keith Pine
7baa4e6d0a Update development_environment.md (#301)
Add pkg-config to list of package dependencies to install.
2019-08-16 11:39:16 +02:00
Joakim Sørensen
8116e9bb26 Add notes about devcontainer (#294)
* Add notes about devcontainer

* corrected typos

* ✏️ Tweaks
2019-07-19 20:15:29 +02:00
Sean Mooney
45031b1ca0 Change OS X to macOS (#276)
Just updating name. It's been called macOS for a little over 3 years now (https://www.wired.com/2016/06/apple-os-x-dead-long-live-macos/).
2019-06-20 00:24:28 -07:00
Yof
e9c657e941 Dev 0.91 needs some extra tox dependencies to run (#200)
* Dev 0.89 needs some extra tox dependencies to run 

This is based on an issue as seen here https://github.com/home-assistant/home-assistant/issues/22068.

* Update development-environment.md based on C.R.

Included the changes needed to run on Windows and Mac. The extra command for OS X is not tested (I am not able to work with OS X).

* Update development_environment.md
2019-03-17 05:00:22 -07:00
Jason Hu
1d5d20d178
Create a separate venv folder should be better (#192) 2019-03-05 20:44:13 -08:00
Fabian Affolter
e78f00bbd5
Minor fix 2019-01-26 11:08:43 +01:00
Fabian Affolter
0aa14a86ef
Fix typos 2019-01-13 21:21:25 +01:00
Fredrik Baberg
442c932a4d Update instructions for Windows (#114)
* Update instructions for Windows.

* Specify a config folder accessible from Windows.
2018-10-08 12:16:31 +02:00
jchasey
80100629d2 Config folder location clarification (#108)
* Config folder location clarification

While this was documented elsewhere in the docs, this is the first thing I was looking for after invoking the dev environment and spent an inordinate amount of time tracking it down.

* link to user docs for clarification

link to user docs to clarify location of config files
2018-10-04 13:43:17 +02:00
Paulus Schoutsen
2f8f31c20e
Remove debugger reference in Windows install 2018-10-02 13:44:05 +02:00
Neil Crosby
502a0959f3 Instruct OSX developers to install autoconf (#103)
When running `tox` on OSX as instructed at https://developers.home-assistant.io/docs/en/development_testing.html an error is received stating `error: [Errno 2] No such file or directory: 'autoconf': 'autoconf'`. 

By installing `autoconf` via `homebrew`, this error goes away, and the `tox` tests pass. Telling OSX developers to install `autoconf` at this point in the development environment setup procedure (rather than calling it out on the testing page) seemed to make sense to me.
2018-10-02 13:33:46 +02:00
cdce8p
96017841e6 Added autoconf note (#93)
* Added autoconf note

* Add autoconf to dep list
2018-09-25 15:01:01 +02:00
Paulus Schoutsen
8010308f6f
Add logging instructions 2018-09-21 11:57:50 +02:00
Sytone
3023dc6bb0 Updated windows instructions (#64)
Added sudo to the apt commands to make it easier and match other apt commands.
2018-08-07 10:17:38 +02:00
Jason Hu
4142ad8ef3 Update setup dev env document (#3)
* python34 => python36

* add upgrade pip step before run setup

* add gcc install for yum

* no need to do pip upgrade
2018-05-01 09:02:35 -04:00
Paulus Schoutsen
2fd443fe2c fix broken links 2018-04-25 14:19:41 -04:00
Paulus Schoutsen
9311326aec Remove unused header 2018-04-24 15:44:32 -04:00
Paulus Schoutsen
632bc81a20 Fix all headers 2018-04-24 11:46:45 -04:00
Paulus Schoutsen
746e35b7a7 Migrate to Docusaurus 2018-04-24 09:52:18 -04:00