Skip to content

Commit

Permalink
More path and format changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Shihab Suliman committed May 20, 2024
1 parent 21bca1b commit f660331
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Contribute to the project

Contributions and issues are most welcome! All issues and pull requests are
handled through [GitHub](https://github.com/PandABlocks/PandABlocks-rootfs-docs/issues). Also, please check for any existing issues before
handled through [GitHub](https://github.com/PandABlocks/PandABlocks-rootfs/issues). Also, please check for any existing issues before
filing a new one. If you have a great idea but it involves big changes, please
file a ticket before making a pull request! We want to make sure you don't spend
your time coding something that might not fit the scope of the project.

## Issue or Discussion?

Github also offers [discussions](https://github.com/PandABlocks/PandABlocks-rootfs-docs/discussions) as a place to ask questions and share ideas. If
Github also offers [discussions](https://github.com/PandABlocks/PandABlocks-rootfs/discussions) as a place to ask questions and share ideas. If
your issue is open ended and it is not obvious when it can be "closed", please
raise it as a discussion instead.

Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
CONFIG
.idea
**/_version.py
5 changes: 5 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,11 @@
"doc_path": "docs",
}

# Removed left-sidebar from all pages
html_sidebars = {
"*": []
}

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
html_show_sphinx = False

Expand Down
17 changes: 8 additions & 9 deletions docs/how-to/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,29 +87,28 @@ d13a99dc0b60ba69f5f8ec1235e5b232 tornado-4.3.tar.gz

These packages are used as follows in the build:

autoconf, automake, libtool, m4, pkg-config:

`autoconf, automake, libtool, m4, pkg-config`:
The rootfs builder needs specific and up to date versions of these tools.
busybox:

`busybox`:
The entire target system environment is run with busybox.
e2fsprogs, mtd-utils:

`e2fsprogs, mtd-utils`:
These packages are needed by the initramfs bootstrap process.
dropbear, ntp:

`dropbear, ntp`:
These provide fundamental target resources: dropbear provides an ssh server, ntp is used for accurate timestamps.
Python, enum34, libressl, numpy, cothread, ws4py:

`Python, enum34, libressl, numpy, cothread, ws4py`:
Python and a variety of supporting libraries will be used for running a number of system components.
conserver, procServ, screen:

`conserver, procServ, screen`:
It is possible that these may be used for server management.
ethtool, iperf, lsof, strace, nano:

`ethtool, iperf, lsof, strace, nano`:
These are useful debugging utilities, together with an easy to use editor.
ncurses, readline, zlib:

`ncurses, readline, zlib`:
These are all libraries used by some of the packages above.

## Output Files
Expand Down
2 changes: 1 addition & 1 deletion docs/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ Technical reference material including APIs and release notes.
reference/*
genindex
Release Notes <https://github.com/PandABlocks/PandABlocks-rootfs-docs/releases>
Release Notes <https://github.com/PandABlocks/PandABlocks-rootfs/releases>
```
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ dev = [
PandABlocks-rootfs = "pandablocks.__main__:main"

[project.urls]
GitHub = "https://github.com/shihab-dls/PandABlocks-rootfs"
GitHub = "https://github.com/PandABlocks/PandABlocks-rootfs"

[[project.authors]] # Further authors may be added by duplicating this section
email = "[email protected]"
Expand Down
5 changes: 0 additions & 5 deletions src/pandablocks/_version.py

This file was deleted.

0 comments on commit f660331

Please sign in to comment.