Skip to content

Commit 3a2e84a

Browse files
committed
Fix references to documentation
won't matter after IronLanguages#1812
1 parent 2dbfd7b commit 3a2e84a

10 files changed

+20
-20
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
The steps to contribute a change are:
44

5-
1. Fork the IronPython3 repository. For more information see [Getting the Sources](Documentation/getting-the-sources.md).
6-
2. Build the repository. For more information see [Building](Documentation/building.md).
7-
1. Make your changes on your machine, ensure ```make.ps1 test-all``` runs successfully, and commit your changes. For more information see [Modifying the Sources](Documentation/modifying-the-sources.md).
5+
1. Fork the IronPython3 repository. For more information see [Getting the Sources](docs/getting-the-sources.md).
6+
2. Build the repository. For more information see [Building](docs/building.md).
7+
1. Make your changes on your machine, ensure ```make.ps1 test-all``` runs successfully, and commit your changes. For more information see [Modifying the Sources](docs/modifying-the-sources.md).
88
1. Push the commits to your fork. This way your name will be the author of the commit in the main IronPython3 tree (once the commits are pulled into the main tree).
99
1. Create a pull request on Github, this will initiate a code review and CLA signing request
1010
1. The IronPython team will review, and possibly request changes, to your PR

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,19 +71,19 @@ See the following lists for features from each version of CPython that have been
7171
For details on contributing see the [Contributing](CONTRIBUTING.md) article.
7272

7373
## Upgrading from IronPython 2
74-
For details on upgrading from IronPython 2 to 3 see the [Upgrading from IronPython 2 to 3](Documentation/upgrading-from-ipy2.md) article.
74+
For details on upgrading from IronPython 2 to 3 see the [Upgrading from IronPython 2 to 3](docs/upgrading-from-ipy2.md) article.
7575

7676
## Differences with CPython
77-
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](Documentation/differences-from-c-python.md) for details.
77+
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](docs/differences-from-c-python.md) for details.
7878

7979
## Package compatibility
80-
See the [Package compatibility](Documentation/package-compatibility.md) document for information on compatibility with popular packages.
80+
See the [Package compatibility](docs/package-compatibility.md) document for information on compatibility with popular packages.
8181

8282
## Installation
83-
Binaries of IronPython 3 can be downloaded from the [release page](https://github.com/IronLanguages/ironpython3/releases/latest), available in various formats: `.msi`, `.zip`, `.deb`, `.pkg`. The IronPython package is also available on [NuGet](https://www.nuget.org/packages/IronPython/3.4.0). See the [installation document](Documentation/installing.md) for detailed instructions on how to install a standalone IronPython interpreter on various operating systems and .NET frameworks.
83+
Binaries of IronPython 3 can be downloaded from the [release page](https://github.com/IronLanguages/ironpython3/releases/latest), available in various formats: `.msi`, `.zip`, `.deb`, `.pkg`. The IronPython package is also available on [NuGet](https://www.nuget.org/packages/IronPython/3.4.0). See the [installation document](docs/installing.md) for detailed instructions on how to install a standalone IronPython interpreter on various operating systems and .NET frameworks.
8484

8585
## Build
86-
See the [building document](Documentation/building.md). Since the main development is on Windows, bugs on other platforms may inadvertently be introduced - please report them!
86+
See the [building document](docs/building.md). Since the main development is on Windows, bugs on other platforms may inadvertently be introduced - please report them!
8787

8888
## Supported Platforms
8989
IronPython 3 targets .NET Framework 4.6.2, .NET Standard 2.0 and .NET 6.0. The support for .NET and .NET Core follow the lifecycle defined on [.NET and .NET Core Support Policy](https://dotnet.microsoft.com/platform/support/policy/dotnet-core).

docs/installing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ Go to the project's [_Actions_ page](https://github.com/IronLanguages/ironpython
158158

159159
# Installing from Sources
160160

161-
To build and install IronPython from sources, first follow instructions in [_Getting the Sources_](https://github.com/IronLanguages/ironpython3/blob/main/Documentation/getting-the-sources.md) and [_Building IronPython3_](https://github.com/IronLanguages/ironpython3/blob/main/Documentation/building.md).
161+
To build and install IronPython from sources, first follow instructions in [_Getting the Sources_](https://github.com/IronLanguages/ironpython3/blob/main/docs/getting-the-sources.md) and [_Building IronPython3_](https://github.com/IronLanguages/ironpython3/blob/main/docs/building.md).
162162

163163
When the command `./make.ps1 debug` completes successfully, runnable and usable `ipy` executables are available in subdirectories of `./bin/Debug`. To run executables from the release configuration (produced by a successful run of `./make.ps1`), first set environment variable `IRONPYTHONPATH`.
164164

eng/choco/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The current target is Python 3.4, although features and behaviors from later ver
99

1010

1111
## Differences with CPython
12-
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/blob/main/Documentation/differences-from-c-python.md) for details.
12+
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/blob/main/docs/differences-from-c-python.md) for details.
1313

1414
## Package compatibility
15-
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/blob/main/Documentation/package-compatibility.md) document for information on compatibility with popular Python packages.
15+
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/blob/main/docs/package-compatibility.md) document for information on compatibility with popular Python packages.

eng/dotnettool/IronPython.Console.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ This package contains a standalone Python interpreter, invokable from the comman
5555

5656
<ItemGroup>
5757
<None Include="README.md" Pack="true" PackagePath="\" />
58-
<None Include="$(RootDir)Documentation\logo.png" Pack="true" PackagePath="\" />
58+
<None Include="$(RootDir)docs\logo.png" Pack="true" PackagePath="\" />
5959
<None Include="$(StageDir)\LICENSE" Pack="true" PackagePath="\" />
6060
<None Include="@(ToolFiles)" Pack="true" PackagePath="\tools\$(TargetFramework)\any\" />
6161
<None Include="$(StageDir)\lib\**" Pack="true" PackagePath="\tools\$(TargetFramework)\any\lib\" />

eng/dotnettool/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ The current target is Python 3.4, although features and behaviors from later ver
99

1010
## Differences with CPython
1111

12-
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/blob/main/Documentation/differences-from-c-python.md) for details.
12+
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/blob/main/docs/differences-from-c-python.md) for details.
1313

1414
## Package compatibility
1515

16-
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/blob/main/Documentation/package-compatibility.md) document for information on compatibility with popular Python packages.
16+
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/blob/main/docs/package-compatibility.md) document for information on compatibility with popular Python packages.

eng/nuget/IronPython.StdLib.nuspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,6 @@
2424
<file src="StdLib.License.txt" />
2525
<file src="lib\**" target="contentFiles\any\any\lib" />
2626
<file src="lib\**" target="content\lib" />
27-
<file src="..\..\..\..\Documentation\logo.png" target="" />
27+
<file src="..\..\..\..\docs\logo.png" target="" />
2828
</files>
2929
</package>

eng/nuget/IronPython.nuspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,6 @@ This package contains the IronPython interpreter engine.</description>
4545
<file src="**\IronPython*.xml" target="lib" exclude="**\IronPythonTest.xml;**\DLLs\*.xml;netcoreapp3.1\**\*;net9.0*\**\*" />
4646
<file src="LICENSE" />
4747
<file src="..\..\..\nuget\README.md" target="" />
48-
<file src="..\..\..\..\Documentation\logo.png" target="" />
48+
<file src="..\..\..\..\docs\logo.png" target="" />
4949
</files>
5050
</package>

eng/nuget/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ System.Console.WriteLine(greetings("world"));
2222

2323
## Differences with CPython
2424

25-
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/blob/main/Documentation/differences-from-c-python.md) for details.
25+
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/blob/main/docs/differences-from-c-python.md) for details.
2626

2727
## Package compatibility
2828

29-
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/blob/main/Documentation/package-compatibility.md) document for information on compatibility with popular Python packages. Note that to run most packages, IronPython Standard Library must be present.
29+
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/blob/main/docs/package-compatibility.md) document for information on compatibility with popular Python packages. Note that to run most packages, IronPython Standard Library must be present.

eng/zip/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ System.Console.WriteLine(greetings("world"));
5050

5151
## Differences with CPython
5252

53-
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/blob/main/Documentation/differences-from-c-python.md) for details.
53+
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/blob/main/docs/differences-from-c-python.md) for details.
5454

5555
## Package compatibility
5656

57-
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/blob/main/Documentation/package-compatibility.md) document for information on compatibility with popular packages. Note that to run most packages, IronPython Standard Library must be present.
57+
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/blob/main/docs/package-compatibility.md) document for information on compatibility with popular packages. Note that to run most packages, IronPython Standard Library must be present.

0 commit comments

Comments
 (0)